https://github.com/c2corg/v6_api
REST API for https://www.camptocamp.org
https://github.com/c2corg/v6_api
Last synced: 5 months ago
JSON representation
REST API for https://www.camptocamp.org
- Host: GitHub
- URL: https://github.com/c2corg/v6_api
- Owner: c2corg
- License: agpl-3.0
- Created: 2015-08-19T11:21:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2026-01-13T10:36:04.000Z (5 months ago)
- Last Synced: 2026-01-13T13:35:56.978Z (5 months ago)
- Language: Python
- Homepage:
- Size: 5.06 MB
- Stars: 26
- Watchers: 10
- Forks: 29
- Open Issues: 144
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [camptocamp.org](https://www.camptocamp.org) API
[](https://github.com/c2corg/v6_api/blob/master/LICENSE)
[](https://app.codacy.com/gh/c2corg/v6_api/dashboard)
[](https://snyk.io/test/github/c2corg/v6_api)
## Development environment
On any OS, install [git](https://git-scm.com/) and [docker](https://docs.docker.com/install/). Then :
### Install
```sh
# Download camptocamp.org source code :
git clone https://github.com/c2corg/v6_api
cd v6_api
```
### Run
```sh
# the very first call may be quite long, (15 minutes, depending of your bandwith)
# time to make a coffee
docker-compose up
```
:heart: :heart:
Press CTRL+C to terminate it.
### Run the background jobs and syncer scripts
In distinct terminals:
```sh
docker-compose exec api make -f config/docker-dev run-background-jobs
docker-compose exec api make -f config/docker-dev run-syncer
```
### Check code quality
In another terminal (`docker-compose up` must be running) :
```sh
./scripts/lint.sh
```
### Run test suite
In another terminal (`docker-compose up` must be running) :
```sh
# full tests, take a while
./scripts/test.sh
# If you need to test a specific point:
./scripts/test.sh c2corg_api/tests/models/test_book.py
# or:
./scripts/test.sh c2corg_api/tests/models/test_book.py::TestBook
# or even:
./scripts/test.sh c2corg_api/tests/models/test_book.py::TestBook::test_to_archive
```
Note: if you're using MinGW on Windows, be sure to prefix the command with `MSYS_NO_PATHCONV=1`
## Useful links in [wiki](https://github.com/c2corg/v6_api/wiki)
[Full info about development environment](https://github.com/c2corg/v6_api/wiki/Development-environment-on-Linux)