verified-generators

This repository contains verified generators ? to be used in the dat project.

Local Development Setup

To run this project locally, follow these steps:

0. Fork this repo on Github

This can be done by clicking here.

1. Set up Python Environment

Make sure you have Python 3.10 (minimum version) installed on your computer. If not, you can download and install it from Python's official website.

2. Clone the Repository

git clone [email protected]:{your-github-username}/verified-generators.git

3. Create a Virtual Environment

Navigate into the cloned directory and create a virtual environment using your preferred method. If you're using venv, you can create a virtual environment like this:

cd verified-generators
python -m venv .venv

4. Activate the Virtual Environment

Activate the virtual environment. The command to activate it depends on your operating system.

• On Unix and MacOS:

  source .venv/bin/activate

• On Windows:

  .venv\Scripts\activate

5. Install Dependencies

pip install poetry
poetry install

This will install all the necessary dependencies for the project.

Developing

Please refer the detailed guide given here.

Intregrating

To integrate your newly written actor with the dat-ui and test it in a connection, head over to the detailed guide here.

Contributing

If you want to contribute to this project, please read the contribution guidelines.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any inquiries or issues regarding the project, feel free to contact us at [email protected].