{"id":23118609,"url":"https://github.com/fabiliria280802/docs-generate-flask","last_synced_at":"2026-04-27T01:31:33.884Z","repository":{"id":267895362,"uuid":"902655520","full_name":"fabiliria280802/docs-generate-flask","owner":"fabiliria280802","description":"This my repo for an flask app that can generate docs and will be use as a microservice for SALEM project","archived":false,"fork":false,"pushed_at":"2025-01-16T15:08:59.000Z","size":1724,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-03T18:58:27.651Z","etag":null,"topics":["contract-generator","docs-generator","flask","invoice-generator","microservice","python","receipt-generator"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fabiliria280802.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2024-12-13T02:12:29.000Z","updated_at":"2025-01-16T15:09:00.000Z","dependencies_parsed_at":null,"dependency_job_id":"c872c76e-c1a9-48b5-98b7-23ca29da7e65","html_url":"https://github.com/fabiliria280802/docs-generate-flask","commit_stats":null,"previous_names":["fabiliria280802/docs-generate-flask"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fabiliria280802/docs-generate-flask","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabiliria280802%2Fdocs-generate-flask","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabiliria280802%2Fdocs-generate-flask/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabiliria280802%2Fdocs-generate-flask/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabiliria280802%2Fdocs-generate-flask/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fabiliria280802","download_url":"https://codeload.github.com/fabiliria280802/docs-generate-flask/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fabiliria280802%2Fdocs-generate-flask/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32319559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-26T23:26:28.701Z","status":"ssl_error","status_checked_at":"2026-04-26T23:26:25.802Z","response_time":129,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["contract-generator","docs-generator","flask","invoice-generator","microservice","python","receipt-generator"],"created_at":"2024-12-17T05:19:09.092Z","updated_at":"2026-04-27T01:31:33.869Z","avatar_url":"https://github.com/fabiliria280802.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask Docs Generator Microservice\n\nThis repository contains a Flask application that generates documentation and serves as a microservice for the SALEM project.\n\n## Table of Contents\n\n- [Project Description](#project-description)\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [API Endpoints](#api-endpoints)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Project Description\n\nThe Flask Docs Generator Microservice is designed to generate documentation for various services and act as a microservice within the SALEM project. This application provides a streamlined way to generate and serve documentation, ensuring that all necessary information is readily accessible.\n\n```plaintext\n.\n├── app.py\n├── requirements.txt\n├── dockerfile\n├── credentials/\n│   └── ...\n├── examples/\n│   └── ...\n├── venv/\n│   └── ...\n├── example/\n│   └── ...\n├── static/\n│   ├── assets\n│   │   └── ...\n│   ├── data-esp\n│   │   └── ...\n│   ├── data-esp\n│   │   └── ...\n│   ├── fonts\n│   │   └── ...\n│   └── signatures\n│       └── ...\n├── tests/\n│   └── ...\n└── templates/\n    ├── base.html\n    ├── deliveryReceipt-list.html\n    ├── deliveryReceipt.html\n    ├── contract.html\n    ├── contract-list.html\n    ├── invoice-list.html\n    └── invoice.html\n```\n\n## Features\n\n- Generate documentation for various services.\n- Serve documentation through a simple API.\n- Easy to integrate into the SALEM project.\n- Built with Flask and supports both Python and HTML.\n\n## Installation\n\nTo install and run the Flask Docs Generator Microservice, follow these steps:\n\n1. **Clone the repository:**\n\n    ```bash\n    git clone https://github.com/fabiliria280802/docs-generate-flask.git\n    cd docs-generate-flask\n    ```\n\n2. **Create a virtual environment:**\n\n    ```bash\n    python3 -m venv venv # On windows use `python -m venv venv\n    `\n    source venv/bin/activate  # On Windows use `.\\venv\\Scripts\\activate`\n    ```\n\n3. **Install the dependencies:**\n\n    ```bash\n    pip install -r requirements.txt # On Windows use ` python -m pip install -r requirements.txt`\n    ```\nIf your are having any trouble with installing the  dependencies for linux/Mac, try using:\n\n    ```bash\n    python3 -m pip install -r requirements.txt\n    ```\n\n4. **Run the Flask application:**\n\n    ```bash\n    flask run --port=5500 # On Windows use `python -m flask --app .\\app.py run`\n    ```\n\nIf your are having any trouble with running teh app on linux/Mac, try using the command for windows:\n\n    ```bash\n     python3 -m flask --app .\\app.py run\n    ```\n\nThe application will be available at `http://127.0.0.1:5000`.\n\n## Usage\n\nOnce the application is running, you can use the provided API endpoints to generate and retrieve documentation.\n\n### Example\n\n```bash\ncurl http://127.0.0.1:5000/generate-docs -d \"service_name=example_service\"\n```\n\n## API Endpoints\n\n- **`POST /generate-docs`**: Generate documentation for a specified service.\n    - Request Body:\n        - `service_name` (string): The name of the service for which to generate documentation.\n    - Response: The generated documentation in HTML format.\n\n- **`GET /docs/\u003cservice_name\u003e`**: Retrieve documentation for a specified service.\n    - URL Parameters:\n        - `service_name` (string): The name of the service for which to retrieve documentation.\n    - Response: The documentation in HTML format.\n\n## Contributing\n\nContributions are welcome! Please follow these steps to contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-branch`).\n3. Make your changes.\n4. Commit your changes (`git commit -m 'Add some feature'`).\n    - We recommend the use of key words at the begin of the commit like feat, fix, bug, ect.\n5. Push to the branch (`git push origin feature-branch`).\n6. Open a pull request.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabiliria280802%2Fdocs-generate-flask","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffabiliria280802%2Fdocs-generate-flask","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffabiliria280802%2Fdocs-generate-flask/lists"}