diff options
| -rw-r--r-- | CHANGELOG.md | 3 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 65 | ||||
| -rw-r--r-- | docs/installation.rst | 8 |
3 files changed, 10 insertions, 66 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f88d749 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +## 0.3.0 (2022-11-24) + +Initial release! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index ba7559b..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,65 +0,0 @@ -# Contributing to Takahē - -## Getting Started - -Development can be done "bare metal" or with Docker. We'll describe both here. - - -### Bare Metal - -Takahē requires Python 3.10 or above, so you'll need that first. Then, create and -activate a virtual environment: - -```shell -$ python3 -m venv .venv -$ . .venv/bin/activate -``` - -You can install the development requirements: - -```shell -$ pip install -r requirements-dev.txt -``` - -...and enable git commit hooks if you like: - -```bash -$ pre-commit install -``` - -Finally, you can run the tests with PyTest: - -```bash -$ pytest -``` - - -### Docker - -The docker build process will take care of much of the above, but you just have -to be sure that you're executing it from the project root. - -First, you need to build your image: - -```shell -$ docker build -f ./docker/Dockerfile -t "takahe:latest" . -``` - -Then start the `compose` session: - -```shell -$ docker compose -f docker/docker-compose.yml up -``` - -Once your session is up and running, you can run the tests inside your -container: - -```shell -$ docker compose -f docker/docker-compose.yml exec web pytest -``` - - -# Code of Conduct - -As a contributor, you can help us keep the Takahē community open and inclusive. Takahē -follows the [Django Project Code of Conduct](https://www.djangoproject.com/conduct/). diff --git a/docs/installation.rst b/docs/installation.rst index 660bd3c..debec48 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -37,7 +37,7 @@ Stator runner. What To Run ----------- -You need to run at least two copies of the Docker image: +You need to run at least two copies of the `Docker image <https://hub.docker.com/r/jointakahe/takahe>`_: * One with no command or arguments specified, which will serve web traffic * One with the arguments (command) ``python manage.py runstator``, which will @@ -48,6 +48,12 @@ Both of these can have as many copies run as needed. Note that the image has required environment variables before it will boot, and this is the only way to configure it - see below. +While you can run Takahē directly from a checkout if you like, we're not +officially supporting that right now, as it increases our support burden by +having to deal with lots of OS and library versions. It's a standard Django +app, though, so if you know what you're doing, have at it - just expect us to +push back if you file tickets about things not working on your OS! + Environment Variables --------------------- |