Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/city-of-helsinki/parking-permits

Backend API for Parking Permits
https://github.com/city-of-helsinki/parking-permits

django

Last synced: about 2 months ago
JSON representation

Backend API for Parking Permits

Host: GitHub
URL: https://github.com/city-of-helsinki/parking-permits
Owner: City-of-Helsinki
License: mit
Created: 2021-03-25T09:35:46.000Z (almost 4 years ago)
Default Branch: develop
Last Pushed: 2024-10-29T08:32:03.000Z (2 months ago)
Last Synced: 2024-10-29T09:48:56.491Z (2 months ago)
Topics: django
Language: Python
Homepage:
Size: 1.78 MB
Stars: 0
Watchers: 6
Forks: 7
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Audit: audit_logger/__init__.py

Awesome Lists containing this project

README

[![Build Status](https://dev.azure.com/City-of-Helsinki/pysakoinnin-verkkokauppa/_apis/build/status/parking-permits-backend%20Test?repoName=City-of-Helsinki%2Fparking-permits&branchName=develop)](https://dev.azure.com/City-of-Helsinki/pysakoinnin-verkkokauppa/_build/latest?definitionId=639&repoName=City-of-Helsinki%2Fparking-permits&branchName=develop)
[![Continuous Integration](https://github.com/City-of-Helsinki/parking-permits/actions/workflows/ci.yml/badge.svg)](https://github.com/City-of-Helsinki/parking-permits/actions/workflows/ci.yml)
[![SonarCloud Analysis](https://github.com/City-of-Helsinki/parking-permits/actions/workflows/analyze-code.yml/badge.svg)](https://github.com/City-of-Helsinki/parking-permits/actions/workflows/analyze-code.yml)

# Parking Permits API

Backend repository for parking permits service in City of Helsinki.

Instructions in this README.md are written with an experienced Python developer in mind. For example,
"docker-compose up" means you already know what docker and docker-compose are, and you already have both installed locally.
This helps to keep the README.md concise.

## Setting up local development environment with Docker

In order to create placeholder for your own environment variables file, make a local `.env.template` copy:

```bash
$ cp .env.template .env
```

Then you can run docker image with:

```bash
docker-compose up
```

- Access development server on [localhost:8888](http://localhost:8888)

- Login to admin interface with `admin` and 🥥

- Done!

## Setting up local development environment with PyEnv and VirtualEnvWrapper

```
pyenv install -v 3.11.9
pyenv virtualenv 3.11.9 parking_permits
pyenv local parking_permits
pyenv virtualenvwrapper
```

Install packages

```
pip install -U pip pip-tools
pip-compile -U requirements.in
pip-compile -U requirements-dev.in
pip-sync requirements.txt requirements-dev.txt
```

## Managing project packages

- We use `pip-tools` to manage python packages we need
- After adding a new package to requirements(-dev).in file, compile it and re-build the Docker image so that the container would have access to the new package

```bash
docker-compose up --build
```

## Running tests

- You can run all the tests with:
```bash
docker-compose exec graphql-api pytest
```
- If you want to run the tests continously while developing:

- Install [fd](https://github.com/sharkdp/fd) using `brew` or equivalent
- Install [entr](https://github.com/eradman/entr) using `brew` or equivalent
- Run pytest whenever a Python file changes with:

```bash
fd --extension py | entr -c docker-compose exec graphql-api pytest
```