`canary_core`

Define the canary_core Django project for interfacing with the HouseCanary API. This project provides a custom Django app for interacting with third-party APIs providing property data: canary_core.hc_api_connector

System Dependencies

Two development strategies are supported by this project: container-based development using Docker, or bare-metal development from a virtual environment. The former requires minimal system dependencies; however, it requires additional IDE configuration steps for PyCharm and VSCode, which are not covered here.

When developing from a virtual environment, the following system dependencies are recommended:

docker
- alternatively, all optional dependencies (except direnv and tox) must be installed to support this application
docker-compose
- Docker Desktop for macOS and Windows provide the Docker Compose CLI; this may be used instead
(optional) poetry
- only required when working from a virtual environment; VSCode can be used to develop directly from inside the project's Docker container
(optional) direnv
- this provides a shortcut to setup/update the project's dev environment; an alternative is to just run the following:
```
$ . ./.envrc
```
(optional) postgresql 14
- the db image managed by this project may be used instead
(optional) tox
- tox is used to run the test suite using multiple python interpreter versions; it works best with pyenv

Production Setup

This project manages Docker images for its API and database layers; accordingly, multiple frameworks can be used to orchestrate the containers.

Demo on a single system:

Download docker-compose.yml and base.env
Rename base.env ⇨ .env
Launch the app by calling docker-compose up
Navigate to localhost:8000 to use the app

Development Setup

After selecting a development strategy and installing necessary dependencies, see the following steps for completing the environment setup.

Container-based Development

To start the minimal production containers locally, you can use docker-compose.

Clone this repo
. ./.envrc to set environment variables
docker-compose pull to pull the required Docker images
export CANARY_CORE_CMD='django-admin runserver' in order to run the development server (by default, the API container runs sleep infinity)
To create the shortcut dev-compose, run eval "$(CANARY_ALIASES)"
- this is just an alias for docker-compose -f docker-compose.yml -f compose/dev.yml
Finally, run dev-compose up -d

The above should start a network of three containers: db (the postgresql database), house_canary (the HouseCanary mock API server), and api (the core API container).

Virtual Environment

To perform the environment setup:

Clone this repo
direnv allow to allow direnv to automatically execute .envrc
Run ./api/docker-entrypoint.sh to start the development server

To start the mock HouseCanary API server, run the following:

$ CANARY_CORE_ROOT_URLCONF=canary_core.hc_api_connector.tests.mock_api django-admin runserver localhost:8080

Next Steps

integrate authorization class / model for restricting property data access to property owners + staff
split pre-commit QA jobs into mypy, flake8, black, and prettier for more clarity/better feedback
add routes for integrating drf-yasg to document the API
build and publish package to internal registry using a CI job
add integration tests for the primary application

Appendix

The following was generated by GitLab and is retained as a reference.

Getting started

To make it easy for you to get started with GitLab, here's a list of recommended next steps.

Already a pro? Just edit this README.md and make it your own. Want to make it easy? Use the template at the bottom!

Add your files

Create or upload files
Add files using the command line or push an existing Git repository with the following command:

cd existing_repo
git remote add origin https://gitlab.com/django-canary/core.git
git branch -M main
git push -uf origin main

Integrate with your tools

Set up project integrations

Collaborate with your team

Test and Deploy

Use the built-in continuous integration in GitLab.

Editing this README

When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to makeareadme.com for this template.

Suggestions for a good README

Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.

Name

Choose a self-explaining name for your project.

Description

Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.

Badges

On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.

Visuals

Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.

Installation

Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.

Usage

Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.

Support

Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.

Roadmap

If you have ideas for releases in the future, it is a good idea to list them in the README.

Contributing

State if you are open to contributions and what your requirements are for accepting them.

For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.

You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.

Authors and acknowledgment

Show your appreciation to those who have contributed to the project.

License

For open source projects, say how it is licensed.

Project status

If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

bryant-finney/canary-core

canary_core