To be written***

Standard file structure for python packages as follows:

• <main folder name>
  • docs/
    • LICENSE.txt
    • README.md <- .rst file type preferred in python, but .md is more common overall
  • src/ <- dedicated src is not always done but recommended for compatibility
    • <module_name> <- often the same name as the main folder, but should be a subfolder
      • __init__.py <- an empty file can be all that's needed at times. However, importing items here can be useful as they will be accessible to any file that is importing the overall module
      • _version.py <- autogenerated by versioneer using info from setup.cfg ¹
      • main.py <- entry point file to be run
      • utils.py
      • <any other python files>
  • versioneer.py <- must be here in the top level folder ¹
  • setup.py <- must be here in the top level folder ²
  • setup.cfg <- must be here in the top level folder ²
  • requirements.txt <- must be here in the top level folder ³
  • MANIFEST.in <- not strictly required
  • build/ <- optional
  • data/ <- optional, can include .csv, .jpg, etc files for the code to access
  • dist/ <- optional, would usually contain .egg, .whl, .tar.gz, etc files
  • examples/ <- optional
  • lib/ <- optional
  • scripts/ <- optional, would contain .sh files in linux/mac
  • tests/ <- optional, would contain python flies

1. https://github.com/yngvem/python-project-structure
2. https://github.com/johnthagen/python-blueprint#project-structure

Run src/ryerrabelli/main.py with python

• Tested primarily on/with
  • Mac OS X - 10.14 Mojave (on a 2018 Macbook pro with 16GB of Ram)
  • Windows 11 (on a Microsoft Surface Laptop 2 with 8GB of Ram)
  • python 3.6-3.9 derived from anaconda
  • PyCharm

See LICENSE.txt

Rahul Sai Yerrabelli

Service	URL
GitHub	https://github.com/ryerrabelli/
ORCID	https://orcid.org/0000-0002-7670-9601
Google Scholar	https://scholar.google.com/citations?user=pEvGRdkAAAAJ
LinkedIn	https://www.linkedin.com/in/ryerrabelli
Email

Table generated using https://www.tablesgenerator.com/markdown_tables