https://github.com/cannlytics/cannlytics-api
The interface 🌐 to the logic of 🔥 Cannlytics.
https://github.com/cannlytics/cannlytics-api
api cannabis cannabis-api cannabis-app cannabis-data cannabisapp django metrc python
Last synced: 27 days ago
JSON representation
The interface 🌐 to the logic of 🔥 Cannlytics.
- Host: GitHub
- URL: https://github.com/cannlytics/cannlytics-api
- Owner: cannlytics
- License: mit
- Created: 2021-02-01T20:18:19.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-03T04:11:19.000Z (almost 5 years ago)
- Last Synced: 2025-10-11T18:25:35.566Z (9 months ago)
- Topics: api, cannabis, cannabis-api, cannabis-app, cannabis-data, cannabisapp, django, metrc, python
- Language: Python
- Homepage: https://cannlytics.com
- Size: 174 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 
Cannlytics API
[](https://opensource.org/licenses/MIT)
[](https://github.com/cannlytics/cannlytics-api/fork)
The Cannlytics API provides an interface to quickly receive samples, perform analyses, collect and review results, and publish certificates of analysis (CoAs). There are also logistics, CRM (client relationship management), inventory management, and invoicing tools. The Cannlytics API comes with [**batteries included**](https://cannlytics.com/support/), but you are always welcome to supercharge your setup with custom modifications.
- [Installation](#installation)
- [Development](#development)
- [Testing](#testing)
- [Publishing](#publishing)
- [License](#license)
Installing the Cannlytics API is simple.
```shell
git clone https://github.com/cannlytics.com/cannlytics-api
```
Running the Cannlytics API locally for development is easy.
```shell
python manage.py runserver 4200
```
or
```shell
npm run dev
```
> Note that the API is run on port 4200 to allow for simultaneous development with other pieces of the Cannlytics engine.
Tests are performed with [`pytest`](https://docs.pytest.org/en/stable/). You can perform the tests by executing the `pytest` command from the `tests` directory.
```shell
cd tests
pytest
```
See [`docs/publishing.md`](docs/publishing.md) for instructions on how to publish the API. Publishing entails containerizing the API, deploying the container to Cloud Run, and directing hosting requests to the containerized app from Firebase Hosting. You can publish using Node.js with one quick command:
```shell
npm run publish
```
This application is released under the [MIT license](LICENSE.md). You can use the code for any purpose, including commercial projects.
[](https://opensource.org/licenses/MIT)
Made with 💖 by Cannlytics.