Python Project Setup

[ebresie]

This will track Python project related features to include

• Setup of a new project
• Configure project specific properties (i.e. version, modules/packages, environment variables, etc.)

[ebresie]

May need to consider Python project conventions like those discussed in the following

• https://stackoverflow.com/questions/193161/what-is-the-best-project-structure-for-a-python-application
• https://docs.python-guide.org/writing/structure/
• https://realpython.com/python-application-layouts/

[ebresie]

This may involve separate issues but may also look into the below references

This may include (1) integrate pyenv for environment setup, (2) integrate setuptools for project dependency setup, (3) compliance with pep-0621 project metadata

https://eugeneyan.com/writing/setting-up-python-project-for-automation-and-collaboration/ https://github.com/pyenv/pyenv https://peps.python.org/pep-0621/ https://pypi.org/project/setuptools/

May want to create "New Project Templates" for assorted configurations including setuptools, setup.py, requirements.txt, and related pyenv (environment) setup element as well.

[ebresie]

May need to provide pip interface as well (likely part of "module" setup functionality) with "requirements.txt" compatibility/interface (i.e. new "requirements.txt" file option)

[ebresie]

Background

• setup.py - used to setup packages more for user of python module
• requirements.txt - used to identify dependency modules for a given project. Usually made up of module==version references. May involve setup for development dependencies (i.e. unit tests, debug, etc.)
• pyenv - used for virtual environment setup
• setuptool - "Easily download, build, install, upgrade, and uninstall Python packages"
• distutil - legacy/deprecated modules for python project distribution functionality. See setuptool
• pep-0621 - Python Enhancement to standardize project metadata

[ebresie]

Reference:

1. https://realpython.com/pipenv-guide/
2. https://github.com/pdm-project/pdm
3. https://github.com/David-OConnor/pyflow
4. https://eugeneyan.com/writing/setting-up-python-project-for-automation-and-collaboration/
5. https://github.com/pyenv/pyenv
6. https://peps.python.org/pep-0621/
7. https://pypi.org/project/setuptools/

[ebresie]

There may be overlap here with

• https://github.com/ebresie/python4nb/issues/11 - New Templates (setuptool)
• https://github.com/ebresie/python4nb/issues/6 - Module Management (pip interface)
• https://github.com/ebresie/python4nb/issues/22 - Virtual Environments (pyenv)

[ebresie]

Some updates for this are captured as part of v0.3.0 release specifically adding a "setup" based project available within "File...New File...Python Setup Based file" context.

Which provides a basic template like the following

[ebresie]

May want to allow project configuration using pyproject.toml configuration file.

See https://packaging.python.org/en/latest/specifications/declaring-project-metadata/