Proposal
We should reorganize the repo into an installable python package with the potential to publish to PyPi. I would suggest reorganizing as per pypi recommendations. An example branch yevgeny/restructure was created off an earlier version of the project with this setup.
packaging_tutorial/
├── LICENSE
├── pyproject.toml
├── README.md
├── setup.cfg
├── setup.py # optional, needed to make editable pip installs work
├── src/
│ └── example_pkg/
│ └── __init__.py
└── tests/
Rationale
- Currently the only way to consume this repo is by changing hard coded values in
rx_api.py and then running this module. In a package structure, we could import functions in more unique ways and allow developers to consume the codebase in a different manner.
- Package structure will allow us to more easily create an installable cmd line tool for inputs if we want.
- Those using jupyter notebooks can more easily import parts of the codebase to explore functions, and contribute.
- This directory structure allows a way to test against a currently installed python module.
- The package itself can be installed in editable mode to help with development
Proposal
We should reorganize the repo into an installable python package with the potential to publish to PyPi. I would suggest reorganizing as per pypi recommendations. An example branch
yevgeny/restructurewas created off an earlier version of the project with this setup.Rationale
rx_api.pyand then running this module. In a package structure, we could import functions in more unique ways and allow developers to consume the codebase in a different manner.