add development info to readme
Browse files- Makefile +1 -1
- README.md +15 -5
- images/Github Social.sketch +0 -0
- images/pytube.png +0 -0
Makefile
CHANGED
@@ -30,7 +30,7 @@ clean-pyc:
|
|
30 |
install: clean
|
31 |
python setup.py install
|
32 |
|
33 |
-
package:
|
34 |
pipenv run python setup.py sdist bdist_wheel
|
35 |
|
36 |
upload:
|
|
|
30 |
install: clean
|
31 |
python setup.py install
|
32 |
|
33 |
+
package: clean-build
|
34 |
pipenv run python setup.py sdist bdist_wheel
|
35 |
|
36 |
upload:
|
README.md
CHANGED
@@ -1,8 +1,5 @@
|
|
1 |
|
2 |
<div align="center">
|
3 |
-
<p>
|
4 |
-
<img src="https://github.com/hbmartin/pytube3/blob/master/images/pytube.png?raw=true" width="350" height="328" alt="pytube logo" />
|
5 |
-
</p>
|
6 |
<p align="center">
|
7 |
<img src="https://img.shields.io/pypi/v/pytube3.svg" alt="pypi">
|
8 |
<a href="https://travis-ci.org/hbmartin/pytube3"><img src="https://travis-ci.org/hbmartin/pytube3.svg?branch=master" /></a>
|
@@ -10,6 +7,7 @@
|
|
10 |
<a href="https://coveralls.io/github/hbmartin/pytube3?branch=master"><img src="https://coveralls.io/repos/github/hbmartin/pytube3/badge.svg?branch=master" /></a>
|
11 |
<a href="https://pypi.python.org/pypi/pytube3/"><img src="https://img.shields.io/pypi/pyversions/pytube3.svg" /></a>
|
12 |
<a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
|
|
|
13 |
</p>
|
14 |
</div>
|
15 |
|
@@ -238,6 +236,18 @@ Finally, if you're filing a bug report, the cli contains a switch called ``--bui
|
|
238 |
|
239 |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
240 |
|
241 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
242 |
|
243 |
-
|
|
|
1 |
|
2 |
<div align="center">
|
|
|
|
|
|
|
3 |
<p align="center">
|
4 |
<img src="https://img.shields.io/pypi/v/pytube3.svg" alt="pypi">
|
5 |
<a href="https://travis-ci.org/hbmartin/pytube3"><img src="https://travis-ci.org/hbmartin/pytube3.svg?branch=master" /></a>
|
|
|
7 |
<a href="https://coveralls.io/github/hbmartin/pytube3?branch=master"><img src="https://coveralls.io/repos/github/hbmartin/pytube3/badge.svg?branch=master" /></a>
|
8 |
<a href="https://pypi.python.org/pypi/pytube3/"><img src="https://img.shields.io/pypi/pyversions/pytube3.svg" /></a>
|
9 |
<a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
|
10 |
+
<a href="https://twitter.com/hmartin"><img src="https://img.shields.io/badge/twitter-@hmartin-blue.svg?style=flat" /></a>
|
11 |
</p>
|
12 |
</div>
|
13 |
|
|
|
236 |
|
237 |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
|
238 |
|
239 |
+
#### Virtual environment
|
240 |
+
|
241 |
+
Virtual environment is setup with [pipenv](https://pipenv-fork.readthedocs.io/en/latest/) and can be automatically activated with [direnv](https://direnv.net/docs/installation.html)
|
242 |
+
|
243 |
+
#### Code Formatting
|
244 |
+
|
245 |
+
This project is linted with [pyflakes](https://github.com/PyCQA/pyflakes) and makes strict use of [Black](https://github.com/ambv/black) for code formatting.
|
246 |
+
|
247 |
+
#### Testing
|
248 |
+
|
249 |
+
This project is tested with [pytest](https://docs.pytest.org/en/latest/) and coverage is evaluated with [coveralls](https://coveralls-python.readthedocs.io/en/latest/index.html)
|
250 |
+
|
251 |
+
#### Code of Conduct
|
252 |
|
253 |
+
Treat other people with helpfulness, gratitude, and consideration! See the [Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
|
images/Github Social.sketch
CHANGED
Binary files a/images/Github Social.sketch and b/images/Github Social.sketch differ
|
|
images/pytube.png
DELETED
Binary file (372 kB)
|
|