Things that can be done to make your pet project better

By

Girish Joshi

@girish946

Project in the begining

Project after sometime

Important?

Is it a lot to do?

No, it's not.

We need to do few things right in the begining of project.

It is not necessary to do everything at once.

We can do one thing at a time.

Things

  • Project template
  • Dependency management
  • Test cases
  • Code Quality
  • Documentation
  • Continuous Integration
  • Packaging
  • Publishing the package/project

Project Template

Project Template Must have

AUTHORS.md
CONTRIBUTING.md
docs/
LICENSE
MANIFEST.in
README.md
requirements.txt
setup.py
tests/
tox.ini
<your-package>/

Don't forget

.gitignore

Dependency Management

Dependency Management Tools

Test cases

Code Quality

Le contributor:

align center

Code Quality Tools

Documentation

Code is read much more often than it is written.

                              - Guido van Rossum
                               (founder of Python)

Documentation

Code tells you how, comment tells you why?

                              - codinghorror.
                                (jeff Atwood)

Documentation tools

CI/CD Pipelines

...

Other tools,

Packaging

Packages

  • setuptools
  • wheel
  • twine
https://packaging.python.org/key_projects

Publishing the package/project

    +
  • Distro Packages

Avoid

Thank you!