Mirrors/coursera-dl
1
0
Fork 0
mirror of https://github.com/coursera-dl/coursera-dl.git synced 2026-01-23 02:35:37 +00:00
Code Issues Projects Releases Wiki Activity

remove doc update step from CONTRIBUTING.md, use markdown in setup.py

Browse source
This commit is contained in:
Yuri Bochkarev 2019-12-16 21:46:23 +01:00
parent fa8f4d810f
commit eed6aafbb1
2 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

6
CONTRIBUTING.md
View file

@ -237,10 +237,8 @@ DRAFT
`git add ... & git ci -m 'Bump version (old_version -> new_version)'`
4. `git tag new_version`
5. `git push && git push --tags`
6. `pandoc --from=markdown --to=rst --output=README.rst README.md`.
I think this is required for PyPI description to look nice.
7. `python setup.py sdist bdist_wheel --universal` to build the package
8. `twine upload dist/coursera-dl-0.6.1.tar.gz` to deploy the package.
6. `python setup.py sdist bdist_wheel --universal` to build the package
7. `twine upload dist/coursera-dl-0.6.1.tar.gz` to deploy the package.
## Docker

6
setup.py
View file

@ -60,9 +60,8 @@ def read_file(filename, alt=None):
generate_readme_rst()
long_description = read_file(
'README.rst',
'Generate README.rst from README.md via pandoc!\n\nExample: '
'pandoc --from=markdown --to=rst --output=README.rst README.md'
'README.md',
'Cannot read README.md'
)
requirements = read_file('requirements.txt')
dev_requirements = read_file('requirements-dev.txt')
@ -101,6 +100,7 @@ setup(
description='Script for downloading Coursera.org videos and naming them.',
long_description=long_description,
long_description_content_type='text/markdown',
keywords=['coursera-dl', 'coursera',
'download', 'education', 'MOOCs', 'video'],
classifiers=trove_classifiers,