Docs/project setup for report module - Githubissues

OpenBCca / airbnb-regulation

Airbnb Regulation Project

MIT License

1 stars 0 forks source link

Docs/project setup for report module #33

Closed alchuu00 closed 9 months ago

alchuu00 commented 9 months ago

Description

Issue Link: #32

Wrote a README with setup guide
Installed Poetry as a dependency managment
Dependencies used: jinja2, poetry, coverage, mypy, pytest, ruff
Initialized folder structure
Setup virtual environment

Type of Change

[x] New feature (non-breaking change which adds functionality)
[x] This change requires a documentation update

How Has This Been Tested?

No tests

Checklist:

Before you submit your pull request, please make sure you have completed the following:

N/A I have read the CONTRIBUTING document.
N/A I have checked that my code adheres to the code style of this project.
[x] I have performed a self-review of my own code.
[x] I have commented my code, particularly in hard-to-understand areas.
[x] I have made corresponding changes to the documentation.
[x] My changes generate no new warnings.
N/A I have added tests that prove my fix is effective or that my feature works.
N/A New and existing unit tests pass locally with my changes.
N/A Any dependent changes have been merged and published in downstream modules.