Skip to content

Latest commit

 

History

History
136 lines (95 loc) · 4.76 KB

README.md

File metadata and controls

136 lines (95 loc) · 4.76 KB
Raw

TMH Registry API

Built with Cookiecutter Django

This repository implements the API for the Tanzanian Mesh Hernia Registry.

Getting Started

These instructions will get you a copy of the project up and running.

Installing

A step by step series of examples that tell you how to get a development env running.

For local development, we use Docker Compose.

First install the prerequisite software:

  1. Install Docker and Docker Compose.
  2. Install Python 3 and pip.

If you want to run outside of Docker you will also need to:

  1. Install PostgreSQL, even if you are not runninga local database this is required for psycopg2, the PostgreSQL database adapter for Python, to correctly install when you make dep.

If you are on Windows and not Linux (or other *nix) you will also need to have installed:

  1. MSYS or an alternative set of Unix compatible tools that includes make.
  2. Microsoft C++ Build Tools which are required to install some of the Python Django dependencies.

First time only

Create a virtual environment for this project.

If you are using pyenv:

pyenv virtualenv registry-api
pyenv activate registry-api

Or if you prefer to use virtualenv directly without pyenv:

# Linux
$ virtualenv venv
$ activate venv

# Windows
> virtualenv venv
> .\venv\Scripts\activate

Run before committing/pushing:

./checkInCheck.sh

Install project dependencies:

make dep

Start Developing

Spin up the project:

make run

Run migrations (every time you update Django models):

make migrate

Run tests:

make test

Run one test:

make test-one file=tmh_registry/registry/tests/api/viewsets/test_discharges.py test_name=TestDischargeCreate

Run checks before committing:

make pre-commit

Everything you need for this project is under Makefile. Take a look at the commands by running make.

Create a local user in Django

Before you can login to the registry you will need to create an account via. the local Django admin console:

  1. Go ot the admin console on http://localhost:8000/admin/ or from Containers in Docker Desktop
  2. Enter the username and password from .envs/.local/.django
  3. Create a new user

Setting up PyCharm (Optional)

Set Up Docker(detailed guide):

  1. Go to File -> Settings -> Build, Execution, Deployment -> Docker
  2. Press the + button to create a Docker configuration if one does not already exist.
  3. Connect to Docker Daemon with your preferred setting and make sure you see a "Connection successful" message.

Set up remote interpreter with Docker-Compose(detailed guide):

  1. Go to File -> Settings -> Project: registry-api -> Python Interpreter.
  2. In the upper right corner, click the cog icon and select Add...
  3. In the Configuration file option, choose the local.yml file.
  4. In the Service option, choose tmh_registry_local_django.
  5. Click OK.

Set up Django Server(detailed guide):

  1. Go to Run -> Edit Configurations.
  2. Press the + button and choose Django Server.
  3. Change the host to 0.0.0.0.
  4. Choose the Python Interpreter you created in the previous step.
  5. Click OK.

Releasing

This project follows Semantic Versioning for releases.

Feel free to use any commit messages you like in the PR. However, please always squash and merge the PR with commit messages that follow the Conventional Commits specification.

Troubleshooting

Accessing the PostgreSQL local database directly

From within the Docker Terminal execute psql -d tmh_registry -U admin to get a local psql session.

Permission Denied in migration files

Generating migration files with the make migrate command, results in files which have the root account as their owner. In order to be able to run pre-commit on them and commit them, you need to change the owner to your user:

sudo chown <your_user>:<your_user> <migration_file>