Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/g4brielvs/landlords
https://github.com/g4brielvs/landlords
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/g4brielvs/landlords
- Owner: g4brielvs
- License: gpl-3.0
- Created: 2024-05-29T16:40:48.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-10T18:10:18.000Z (7 months ago)
- Last Synced: 2024-10-15T15:10:57.746Z (2 months ago)
- Language: Jupyter Notebook
- Homepage: http://g4brielvs.me/landlords/
- Size: 7.37 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Leveraging NYC Open Data to Identify Potential Potential Housing Maintenance Code in New York City
The New York Attorney General (NYAG) is actively combating various harmful landlord practices such as tenant harassment, deed theft, and bank fraud, which adversely impact tenants and homeowners. By leveraging open data publicly available through [NYC Open Data](https://opendata.cityofnewyork.us), this projects uses data analysis tools to identify, describe, and visualize characteristics of landlords engaging in harmful behaviors.
The solution is implemented in a [Jupyter notebook](notebooks/landlords.ipynb) and presented as a [Jupyter Book](_build/html/index.html). The web book is publicly available at https://g4brielvs.github.io/landlords.
## Installation
**landlords** can installed using `pip`:
### From Source
1. Clone or download this repository to your local machine. Then, navigate to the root directory of the repository:
```shell
git clone https://github.com/g4brielvs/landlords.git
cd landlords
```
2. Create a virtual environment (optional but recommended):
```shell
python3 -m venv venv
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
```
3. Install the package with dependencies:
```shell
pip install .
```
Install the package **in editable** mode with dependencies:
```shell
pip install -e .
```
The `-e` flag stands for "editable," meaning changes to the source code will immediately affect the installed package.
### Building Documentation Locally
To build the documentation locally, after (1) and (2) above, please follow these steps:
- Install the package with documentation dependencies:
```shell
pip install -e .[docs]
```
- Build the documentation:
```shell
jupyter-book build . --config docs/_config.yml --toc docs/_toc.yml
```
The generated documentation will be available in the `_build/html` directory. Open the `index.html` file in a web browser to view it.
## License
This projects is licensed under the [**GNU General Public License v3**](https://opensource.org/license/gpl-3-0) - see the [LICENSE](LICENSE) file for details.