PyThings

THIS PROJECT IS IN ALPHA! YOU HAVE BE WARNED!

PyThings is an open-source and general purpose development framework design to model, interact with and manipulate any entity - abstract or tangible - through a structured model inspired by the Suggested Upper Merged Ontology. It's core focus is on providing a rich, extensible foundation for representing and working with Things in a flexible and scalable way.

More than a typical object-oriented framework; it's a generalised, structured way to model reality itself. Whether you're building AI-driven applications knowledge graphs, automation systems, or just looking to cut down your workload. PyThings provides a standardised yet flexible foundation.

Getting Started

These instructions will give you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on deploying the project on a live system.

Prerequisites

Requirements for the software and other tools to build, test and push

• Python 3.13
• Example 2

Installing

PyThings is available as a Python package.

To install:

pip instal pythings

Additional domains and extensions can be found here, and follow the convention:

# Domain and definition expansions
pip install pythings-<domain_name>

# Plugins
pip install pythings-ext-<name>

Official domains are also downloadable within the codebase but this is generally not recommended.

Extending & Expanding

Explain how to run the automated tests for this system

General Extensions

General extensions are those generally affecting the functionality of the package.

Give an example

Domain Specific Extensions

DSFs are those that are specific to a particular domain or use case, and typically expand or form part of the lower ontology.

Give an example

Deployment

Add additional notes to deploy this on a live system

Built With

• Contributor Covenant - Used for the Code of Conduct
• Creative Commons - Used to choose the license

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use Semantic Versioning for versioning. For the versions available, see the tags on this repository.

Authors

The PyThings project was founded and is driven by DirtyWork Solutions.

• Aidan Hogg - Launched the project - DirtyWork Solutions
• Billie Thompson - Provided README Template - PurpleBooth

See also the list of contributors who participated in this project.

License

This project is licensed under the CC0 1.0 Universal Creative Commons License - see the LICENSE.md file for details

Acknowledgments

• Hat tip to anyone whose code is used
• Inspiration
• etc