{"id":23154719,"url":"https://github.com/micaelleos/functionalagent","last_synced_at":"2026-04-13T01:10:21.948Z","repository":{"id":261227541,"uuid":"846023097","full_name":"micaelleos/FunctionalAgent","owner":"micaelleos","description":"Effortlessly create functional documentation with AI and integrate directly with Jira. Generate, refine, and export User Stories to your Jira project in just a few clicks! 🚀","archived":false,"fork":false,"pushed_at":"2024-11-28T17:02:27.000Z","size":254,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-10T02:18:07.062Z","etag":null,"topics":["agent","ai","jira-rest-api","langchain","openai","python","react-agent","streamlit"],"latest_commit_sha":null,"homepage":"https://functionalagent.streamlit.app/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/micaelleos.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-22T11:47:46.000Z","updated_at":"2024-12-21T02:41:36.000Z","dependencies_parsed_at":"2024-11-05T12:48:04.759Z","dependency_job_id":"1558fdb2-e9f2-4472-8a0b-80abe6bcbd37","html_url":"https://github.com/micaelleos/FunctionalAgent","commit_stats":null,"previous_names":["micaelleos/funcitionalagent","micaelleos/functionalagent"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micaelleos%2FFunctionalAgent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micaelleos%2FFunctionalAgent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micaelleos%2FFunctionalAgent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/micaelleos%2FFunctionalAgent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/micaelleos","download_url":"https://codeload.github.com/micaelleos/FunctionalAgent/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247215581,"owners_count":20903003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent","ai","jira-rest-api","langchain","openai","python","react-agent","streamlit"],"created_at":"2024-12-17T20:13:45.370Z","updated_at":"2026-04-13T01:10:16.912Z","avatar_url":"https://github.com/micaelleos.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Functional AI Agent for Jira Integration\n\n## Overview\nThis project is a **Functional AI Agent** designed to assist users in building **functional documentations** and seamlessly integrate with **Jira**. Using cutting-edge AI, this agent helps users generate and refine **User Stories** and other functional requirements. Once the User Stories are ready, they can be automatically exported to the desired Jira project.\n\nThe application leverages **Python**, **Streamlit** for the user interface, and **LangChain** for managing the AI interactions, ensuring a robust and intuitive experience.\n\n---\n\n## Key Features\n- **AI-Powered Documentation**: Generate and refine functional documentations and User Stories based on user input.\n- **Jira Integration**: Directly export finalized User Stories to your Jira project, streamlining the development workflow.\n- **Intuitive Interface**: Built with Streamlit for a clean and easy-to-use UI.\n- **Context-Aware Suggestions**: Provides actionable recommendations for improving your documentation quality.\n\n---\n\n## Tech Stack\n- **Python**: Core programming language for the application.\n- **Streamlit**: Simplified framework for building interactive web applications.\n- **LangChain**: Framework to build and manage AI-powered functionalities.\n- **Jira API**: To interact with Jira for creating issues directly from the application.\n\n---\n\n## Installation\n\n1. **Clone the Repository**\n   ```bash\n   git clone https://github.com/micaelleos/FunctionalAgent.git\n   cd FunctionalAgent\n   ```\n\n2. **Set Up a Virtual Environment**\n   ```bash\n   python -m venv env\n   source env/bin/activate  # On Windows: env\\Scripts\\activate\n   ```\n\n3. **Install Dependencies**\n   ```bash\n   pip install -r requirements.txt\n   ```\n\n4. **Set Up Environment Variables**\n   - Create a `.env` file in the root directory with the following:\n     ```env\n     OPENAI_API_KEY=your-openai-api-key\n     ```\n   Replace the placeholders with your actual credentials.\n\n5. **Run the Application**\n   ```bash\n   streamlit run app.py\n   ```\n\n---\n\n## Usage\n\n1. **Generate Functional Documentation**\n   - Start the application and input a description of your project or requirements.\n   - The agent will generate User Stories and suggest improvements.\n\n2. **Refine the Stories**\n   - Review and edit the generated stories as needed.\n\n3. **Export to Jira**\n   - Select the stories you wish to export and specify the Jira project key.\n   - Click **Export**, and the agent will create the issues in Jira.\n\n---\n\n## Example Workflow\n\n1. Enter your jira credentials. Click in gear icon.\n2. Describe the feature: _\"As a user, I want to log in using my email and password.\"_\n3. The agent generates:\n   ```\n   User Story:\n   - As a user, I want to log in using my email and password so that I can access my account securely.\n   Acceptance Criteria:\n   - The system validates user credentials.\n   - Invalid attempts show an appropriate error message.\n   ```\n4. Refine the story and add additional details if necessary.\n5. Ask the agent to export it to Jira under the project key you want (**PROJ**).\n\n---\n\n## Contributing\n\n1. Fork the repository.\n2. Create a feature branch: `git checkout -b feature/new-feature`.\n3. Commit your changes: `git commit -m 'Add a new feature'`.\n4. Push to the branch: `git push origin feature/new-feature`.\n5. Open a Pull Request.\n\n---\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n---\n\n## Contact\n\nFor any questions, feel free to reach out:\n- **Email**: micaelle.osouza@gmail.com\n---\n\nHappy Building 🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicaelleos%2Ffunctionalagent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicaelleos%2Ffunctionalagent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicaelleos%2Ffunctionalagent/lists"}