Colin Bitterfield
1 min readJan 16, 2020

--

I just finished building a first PyPi application. There is a lot to these issues that is glossed over. I spent 2 hours dealing with import . version related issues and opted for another method. I learned most of these pitfalls in the last few weeks.

Something to add (and if you like collaboration, please let me know)

  1. IDE setup (IntelliJ or Eclipse / both): Plugins and configurations needed.
  2. Dealing with __version__ and other __ variables.
  3. Accounts needed for package: Github, ReadtheDocs, TravisCI, PyPi, Test.PyPi, Possibly Docker
  4. Needs to edit .rst and Markdown (MacDown is useful and free)
  5. Building Test Cases so that CI/CD works.
  6. Integrating Docker Hub and Docker Builds.
  7. Style Guides and CLI requirements
  8. This builds the entire structure for a python project and is very useful: https://github.com/toptive/generator-toptive-python
  9. GitHub, Git and GitDesktop integrations.
  10. Initial setup of build environments.
  11. Setup.py to create run-time scripts.
  12. Workflow to release and increment version numbers (Bumpversion)
  13. Use if UML and .DOT diagrams
  14. Documentation builds and explanations.
  15. Setup.py and required “Tags”
  16. Badges for github, travis and etc.( https://img.shields.io)

--

--

Colin Bitterfield
Colin Bitterfield

Written by Colin Bitterfield

NIST certified Security Professional | 10+ years experience in infrastructure security and compliance | Experienced in creating security programs.

Responses (1)