cannlytics / cannlytics-engine

A Python 🐍 package that implements the logic of 🔥 Cannlytics.

Cannabis data science and analytics.

https://cannlytics.com

🔥 Cannlytics is a suite of tools that you can use to wrangle, standardize, and analyze cannabis data. We believe that people in the cannabis space would benefit from organized, decentralized, and accessible data. This repository contains each core component of Cannlytics and detailed instructions on how to build, develop, publish, and use each tool. You can find more information about each tool below:

Component	Status	Production URL
🦾 Cannlytics AI	🟢	https://data.cannlytics.com
📡 Cannlytics API	🟢	https://cannlytics.com/api
📱 Cannlytics App	🟡	https://app.cannlytics.com
📜 Cannlytics Documentation	🟡	https://docs.cannlytics.com
🐍 Cannlytics Python SDK	🟢	https://pypi.org/project/cannlytics/
🌐 Cannlytics Website	🟢	https://cannlytics.com

🍁 Datasets

Cannlytics Datasets is a collection of cannabis data from around the world. The data is archived locally, stored in a cloud database, and available for download from Hugging Face.

Dataset	Description
cannabis_licenses	Cannabis license data for each state with permitted adult-use cannabis.
cannabis_tests	Public cannabis lab test results.

🧑‍🚀 Cannabis Data Science

Do you want to join a team of data scientists from around the world who are advancing cannabis science, molecule by molecule? 🧬 Come to the Cannabis Data Science Meetup Group! At the meetup, you will be introduced to many useful notes, notebooks, and video tutorials to help you get, wrangle, and analyze cannabis data with the best of them. Join the fun on Wednesdays at 8:30am PST / 9:30am MT / 10:30am CT / 11:30am EST. You are always welcome to use the code, watch the videos, and make contributions of your own! Please tune in 🚀

👨‍🏭 Contributing

Contributions are always welcome! You are encouraged to submit issues, functionality, and features that you want to be addressed. See the contributing guide to get started. Anyone is welcome to contribute anything. Currently, the project could greatly benefit from:

• 👨‍💻 Code
• 💡 Ideas
• 👷 Tests
• 🖊️ Documentation
• 🏹 Examples

💖 Support

Cannlytics is made available with hard work and your good will. Please consider making a contribution to help us continue crafting useful tools and data pipelines for you. Thank you 🙏

Provider	Link
👐 OpenCollective	https://opencollective.com/cannlytics-company

🏛️ License

Copyright (c) 2020-2023 Cannlytics and The Cannabis Data Science Team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

cannlytics-engine's Issues

Instrument data import needed

The ability to import data from scientific instruments is needed.

Write LIMS documentation

Documentation needs to be written for the LIMS functionality.

Certificate of analysis (CoA) creation needed

Certificate of analysis (CoA) creation is needed for labs. Ideally integrate with Firebase's Firestore database and with the Metrc API for traceability.

Write Metrc module documentation

Documentation needs to be written for the functionality in the metrc module.

Examples needed!

A myriad of examples are needed, from use of the lims module to use of the metrc module and some of the more handy utils.

`logistics.py` and `scraper.py` need tests

Unit tests need to be written for logistics.py and scraper.py in the cannlytics module. The tests should be named logistics_test.py and scraper_test.py and should be located in the tests directory. See firebase_test.py and find_labs_dev.py for examples of unit tests.

A way to test the functions can be to use them to find details for licensed cannabis waste disposal facilities in Oklahoma. Ideally, details can be found for a facility given only it's name, e.g. Egnite Waste Management. A map of facilities can be found at https://oklahoma.gov/omma/businesses/list-of-licensed-businesses/licensed-waste-disposal-facility.html

Finish package functionality: remediate, update_note, change_location, update_items, update, delete

Several endpoints / actions still need to be implemented in the Package model.