Skip to content

Latest commit

 

History

History
90 lines (53 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

90 lines (53 loc) · 2.7 KB
Raw

Contributing to TaskingAI

We welcome contributions from the community and are pleased to have you join us. This document will help you get started.

Developing Locally with Poetry

Poetry is a dependency management and packaging tool in Python that makes it easy to manage virtual environments. It's particularly useful when you need to test changes to the TaskingAI client in a local development setup.

Whether you're looking to fix a bug, add a new feature, or just improve the TaskingAI client, you'll want to be able to:

  1. Test your changes in isolation from your system Python installation.
  2. See your changes reflected immediately in any local code that imports the TaskingAI client.
  3. Keep track of your changes in git to enable collaboration and code review through GitHub pull requests.

Step 1: Fork and Clone the Repository

First, create a fork of the TaskingAI client repository on GitHub, and then clone your fork locally:

git clone https://github.com/<your-username>/taskingai-python-client.git
cd taskingai-python-client

Step 2: Install Poetry

You can install Poetry by following the instructions on the official website.

Step 3: Install Dependencies

Once Poetry is installed, you can install all the required dependencies by running:

poetry install

Step 4: Activate the Virtual Environment

Enter the virtual environment shell created by Poetry:

poetry shell

Verify the setup:

poetry env info

Step 5: Make Changes and Test

Now you can start making changes to the TaskingAI client. To test your changes, you may want to:

  • Write unit tests.
  • Run the TaskingAI client in your local applications or Jupyter Notebooks.

Step 6: Push Changes and Create a Pull Request

After making your changes, push them to your fork and create a pull request on the original TaskingAI repository.

Load Your Virtualenv in Another Shell

To use your development version of the TaskingAI client in another application or Jupyter Notebook:

Get the Path to Your Virtualenv

Run:

poetry env info --path

Activate Your Virtualenv

Source the activate script in your virtualenv:

source <your-virtualenv-path>/bin/activate

Test Your Virtualenv

Create a test file in your TaskingAI client code directory and another in your second shell to verify that changes to the client are reflected immediately.

Need Help?

If you have any questions or run into issues, please file an issue on GitHub.

Thank you for contributing to TaskingAI!