Metadata-Version: 2.1
Name: jf-agent
Version: 0.0.4
Summary: An agent for collecting data for jellyfish
Home-page: https://github.com/Jellyfish-AI/jf_agent
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: jira
Requires-Dist: tqdm
Requires-Dist: stashy

# jf_agent

An agent that can run on-premise and collect data to be sent to [Jellyfish](https://jellyfish.co).

## Usage

1. Install jf_agent with `pip`:
```bash
pip install jf_agent
```
2. For Jira: Gather your Jira credentials. You'll need a Jira username with read access to the right projects, along with an API token for that user.

3. Set up environment variables with your Jira credentials. Set JIRA_USERNAME and JIRA_PASSWORD to the username and API token you found above.

4. For Bitbucket: Gather your Bitbucket credentials. Set the `BITBUCKET_USERNAME` and `BITBUCKET_PASSWORD` environment variables to appropriate values.

5. Run `jf_agent` with the URL for the service to produce data for:
```
jf_agent -o <output_directory> [--jira-url <jira_URL>] [--bitbucket-url <BITBUCKET_URL>]
```

6. Collect the generated files from the output directory you specified, and send them to Jellyfish.


