Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Building an open source Python application, the...
Search
Kiran
October 26, 2013
Technology
0
390
Building an open source Python application, the right way
Overview of conventions/best practices to follow when writing an open source Python application
Kiran
October 26, 2013
Tweet
Share
More Decks by Kiran
See All by Kiran
Building Terrariums
kirang89
0
16
The Road to a Masterless Multi-node Distributed System in Elixir
kirang89
5
650
Building a Tic Tac Toe AI in Python
kirang89
0
360
A Gentle Introduction to Generators and Coroutines
kirang89
1
220
Leverage PyCon India to help grow the Python community
kirang89
0
69
Lets learn Python !
kirang89
0
88
Python Month
kirang89
0
47
Why learn Python ?
kirang89
0
110
Other Decks in Technology
See All in Technology
CRTO/CRTL/OSEPの比較・勉強法とAV/EDRの検知実験
chayakonanaika
1
1.1k
The XZ Backdoor Story
fr0gger
0
3.5k
EitherT_with_Future
aoiroaoino
1
1.2k
Evolving DevOps Teams and Flexible Organizational Culture
kakehashi
1
260
難しいから面白い!医薬品×在庫管理ドメインの複雑性と向き合い、プロダクトの成長を支えるための取り組み / Initiatives to Support Product Growth
kakehashi
2
190
Jetpack Compose Modifier 徹底解説 / Jetpack Compose Modifier
wiroha
0
140
効果的なオンコール対応と障害対応
ryuichi1208
5
2.8k
Monitor GraalVM Native Apps with OpenTelemetry
logico_jp
0
130
Functional TypeScript
naoya
11
4.6k
20240911_New_Relicダッシュボード活用例
speakerdeckfk
0
100
Privacy Sandbox on Android / DroidKaigi 2024
7pairs
1
170
2024年版 運用者たちのLLM
nwiizo
3
580
Featured
See All Featured
Designing Experiences People Love
moore
138
23k
How to Think Like a Performance Engineer
csswizardry
16
950
How GitHub Uses GitHub to Build GitHub
holman
472
290k
Atom: Resistance is Futile
akmur
261
25k
The Cost Of JavaScript in 2023
addyosmani
42
5.2k
Infographics Made Easy
chrislema
239
18k
Testing 201, or: Great Expectations
jmmastey
36
7k
Building a Modern Day E-commerce SEO Strategy
aleyda
36
6.8k
The Illustrated Children's Guide to Kubernetes
chrisshort
47
48k
Designing for Performance
lara
604
68k
The Art of Programming - Codeland 2020
erikaheidi
48
13k
Side Projects
sachag
451
42k
Transcript
Building open source the Python application right way an
Hi.
I’m Kiran. Hacker Programmer Open Source enthusiast Computer Science fanboy
Currently, having an affair with Python
Why follow Conventions Guidelines Best Practices
Your code is Open Source !
What does that mean You ask ?
Code available to People will try to help start using
it everyone People will(might)
So, what do I do ?
Make it easier for people to use your application
How ?
Let’s start with basic project structure
None
Let’s make it simpler
Documentation Tests Application Dependency Management Setup Task Execution Extras Publish
Application
Write good code. http://www.python.org/dev/peps/pep-0008/
Don’t bloat your code with Use them when required classes
to architect your application modules Use
Tests
“Code not tested is broken by design” - Jacob Kaplan
Moss
Lots of ways to your application Test
Start with simple unit tests
unittest Nose py.test Most commonly used
Documentation
For small projects Code is the documentation http://www.python.org/dev/peps/pep-0257/
Sadly This is not scalable
Use Sphinx http://sphinx-doc.org/
HTML EPUB PDF Man Pages LaTex Automatic Syntax Highlighting Plain
Text Theming Support Internationalisation
None
Dependency Management
Project Dependencies requirements.txt
pip install -r requirements.txt then
None
Setup
Pro Tip: Use Virtualenv to setup your environment
Why ? Test with different Python versions No unnecessary namespace
pollution Different environments and settings per project Install dependencies inside environment
Publish
setup.py contains the necessary information required for it’s installation Every
project’s
Packages and uploads your application to Python Package Index a.k.a
PyPI
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', )
Register at PyPI python setup.py register Package and Upload application
python setup.py sdist upload
Install application on any platform pip install myapp
None
Task Execution
Makefile Use a to automate multiple tasks and commands http://mrbook.org/tutorials/make/
Extras (a.k.a enhancements)
AUTHORS CHANGELOG CONTRIBUTING
is License very important for open source projects http://www.tldrlegal.com/
Recap
RECAP Documentation Tests Application Dependency Management Setup Task Execution Extras
Publish
Questions ?
Thank you ! @kirang89 http://kirang.in