README.md

UGRC Python Starter Tempalate

UGRC's default Python project configuration/template

Installation

1. Create new environment for the project
   • With python 3 (without arcpy)
     • python -m venv .env
     • activate the environment source .env/bin/activate
   • With conda
     • conda create --name PROJECT_NAME python=3.7
2. Rename src/projectname folder to your desired project name
3. Edit the setup.py:name, url, project_urls, keywords, and entry_points to reflect your new project name
4. Edit the test_projectname.py to match your project name.
   • You will have one test_filename.py file for each file in your src directory and you will write tests for the specific file in the test_filename.py file
5. Navigate to codecov.io and create a CODECOV_TOKEN project secret
6. Install an editable package for development
   • pip install -e ".[tests]"
   • add any project requirements to the setup.py:install_requires array
7. Run the tests
   • VSCode -> Python: Run All Tests or Python: Debug All Tests
   • ptw
     • Pytest Watch will restart the tests every time you save a file
8. Bring your test code coverage to 80% or above!