![setup(
name='project name',
version=myapp.__version__,
description='project description here',
license=open("LICENSE").read(),
author='author',
author_email='email',
url='project url',
packages=['myapp'],
include_package_data=True,
classifiers=(
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Natural Language :: English',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.3',
),
test_suite='tests',
)](https://image.slidesharecdn.com/buildinganopensourcepythonapplicationtherightway-131028123758-phpapp02/75/Building-an-open-source-python-application-the-right-way-41-2048.jpg)
![setup(
name='project name',
version=myapp.__version__,
description='project description here',
license=open("LICENSE").read(),
author='author',
author_email='email',
url='project url',
packages=['myapp'],
include_package_data=True,
classifiers=(
'Development Status :: 5 - Production/Stable',
'Intended Audience :: Developers',
'Natural Language :: English',
'License :: OSI Approved :: MIT License',
'Programming Language :: Python',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.3',
),
test_suite='tests',
)](https://crownmelresort.com/image.slidesharecdn.com/buildinganopensourcepythonapplicationtherightway-131028123758-phpapp02/75/Building-an-open-source-python-application-the-right-way-41-2048.jpg)
Uploaded byKiran Gangadharan
Building an open source python application the right way
The document provides guidelines for building an open source Python application the right way. It recommends following best practices and conventions to make the code easy to use by others. The key aspects covered are: writing good code and tests, using documentation and modules, managing dependencies, setting up virtual environments, publishing to PyPI, and automating tasks with Makefiles. Additional recommendations include adding AUTHORS, CHANGELOG, CONTRIBUTING and license files. The goal is to structure the project properly and follow open source conventions to encourage contributions from others.
More Related Content
Similar to Building an open source python application the right way
Building an open source python application the right way
- 1. Building an opensource Python application the right way
- 2.
- 3. I’m Kiran. Hacker Programmer Open Sourceenthusiast Computer Science fanboy
- 4. Currently, having anaffair with Python
- 5.
- 6. Your code is OpenSource !
- 7. What does thatmean You ask ?
- 8. Code available to Peoplewill everyone start using it People will(might) try to help
- 9. So, what doI do ?
- 10. Make it easierfor people to use your application
- 11.
- 12. Let’s start with basicproject structure
- 14. Let’s make itsimpler
- 15.
- 16.
- 17.
- 18. Don’t bloat yourcode with classes Use them when required
- 19. Use modules to architect yourapplication
- 20.
- 21. “Code not testedis broken by design” - Jacob Kaplan Moss
- 22. Lots of waysto Test your application
- 23. unit tests Start withsimple
- 24.
- 25.
- 26. For small projects Codeis the documentation http://www.python.org/dev/peps/pep-0257/
- 27.
- 28.
- 29.
- 31.
- 32.
- 33. then pip install -rrequirements.txt
- 35.
- 36. Pro Tip: Use Virtualenv to setupyour environment
- 37. Why ? Test withdifferent Python versions Install dependencies inside environment No unnecessary namespace pollution Different environments and settings per project
- 38.
- 39. Every project’s setup.py contains thenecessary information required for it’s installation
- 40. Packages and uploadsyour application to Python Package Index a.k.a PyPI
- 41. setup( name='project name', version=myapp.__version__, description='project descriptionhere', license=open("LICENSE").read(), author='author', author_email='email', url='project url', packages=['myapp'], include_package_data=True, classifiers=( 'Development Status :: 5 - Production/Stable', 'Intended Audience :: Developers', 'Natural Language :: English', 'License :: OSI Approved :: MIT License', 'Programming Language :: Python', 'Programming Language :: Python :: 2.6', 'Programming Language :: Python :: 2.7', 'Programming Language :: Python :: 3.3', ), test_suite='tests', )
- 42. Register at PyPI pythonsetup.py register Package and Upload application python setup.py sdist upload
- 43. Install application onany platform pip install myapp
- 45.
- 46. Use a Makefile to automatemultiple tasks and commands http://mrbook.org/tutorials/make/
- 47.
- 48.
- 49. License is very important for opensource projects http://www.tldrlegal.com/
- 50.
- 51.
- 52.
- 53.