{"id":21076010,"url":"https://github.com/marcbperez/flask-reportservice","last_synced_at":"2026-04-18T04:02:27.888Z","repository":{"id":258645060,"uuid":"82347974","full_name":"marcbperez/flask-reportservice","owner":"marcbperez","description":"A Flask service to export PDF and XML reports.","archived":false,"fork":false,"pushed_at":"2020-11-18T12:04:40.000Z","size":34,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-14T03:44:56.691Z","etag":null,"topics":["docker","flask","gradle","python","reporting"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marcbperez.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2017-02-17T23:48:41.000Z","updated_at":"2025-01-01T04:07:56.000Z","dependencies_parsed_at":"2024-10-20T00:50:49.017Z","dependency_job_id":null,"html_url":"https://github.com/marcbperez/flask-reportservice","commit_stats":null,"previous_names":["marcbperez/flask-reportservice"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/marcbperez/flask-reportservice","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fflask-reportservice","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fflask-reportservice/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fflask-reportservice/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fflask-reportservice/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marcbperez","download_url":"https://codeload.github.com/marcbperez/flask-reportservice/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marcbperez%2Fflask-reportservice/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31955919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["docker","flask","gradle","python","reporting"],"created_at":"2024-11-19T19:26:03.684Z","updated_at":"2026-04-18T04:02:27.865Z","avatar_url":"https://github.com/marcbperez.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# flask-reportservice\n\nA Flask service to export PDF and XML reports.\n\n## Installation\n\nThis projects uses Gradle (at least version 3.3) as its build system along with\na Docker and docker-compose wrapper for continuous development. On Debian Linux\ndistributions Gradle can be installed with the following commands:\n\n```bash\nsudo apt-get install software-properties-common\nsudo add-apt-repository ppa:cwchien/gradle\nsudo apt-get update\nsudo apt-get install default-jdk gradle-3.4\n```\n\nIf you prefer to install Docker and docker-compose (highly recommended) refer to\nthe [official instructions][install-docker-compose].\n\n## Usage\n\nTo start the service get the project and install its dependencies, set the\nenvironment variables and run flask. The service will be available at\n`http://localhost:5000`.\n\n```bash\ngit clone https://github.com/marcbperez/flask-reportservice\ncd flask-reportservice\nexport FLASK_APP=\"reportservice\"\nexport SECRET_KEY=\"non-production-key\"\nexport DB_HOST=\"url.to.database\"\nexport DB_PORT=\"5432\"\nexport DB_USER=\"username\"\nexport DB_PASS=\"password\"\nexport DB_NAME=\"reportservice\"\nsudo -HE gradle\nsudo -HE flask run\n```\n\nReports can be exported to PDF and XML. There are also service actions to get a\nlist of available reports in HTML and XML format.\n\n  - `http://localhost:5000/` and `http://localhost:5000/report` show a list of\n    the reports and its links.\n  - `http://localhost:5000/report/list.xml` offers the same list in XML format.\n  - `http://localhost:5000/report/\u003creport_id\u003e` shows the report in HTML.\n  - `http://localhost:5000/report/\u003creport_id\u003e.pdf` shows the report in PDF.\n  - `http://localhost:5000/report/\u003creport_id\u003e.xml` shows the report in XML.\n\n## Testing\n\nTests will be executed by default every time the project is built. To run them\nmanually start a new build or use Gradle's test task. For a complete list of\ntasks check `gradle tasks --all`.\n\n```bash\nexport FLASK_APP=\"reportservice\"\nexport SECRET_KEY=\"non-production-key\"\nexport DB_HOST=\"url.to.database\"\nexport DB_PORT=\"5432\"\nexport DB_USER=\"username\"\nexport DB_PASS=\"password\"\nexport DB_NAME=\"reportservice\"\nsudo -HE gradle test\n```\n\nA continuous build cycle can be executed with `gradle --continuous` inside a\nvirtual environment, or with Docker.\n\n```\nsudo docker-compose up\n```\n\n## Troubleshooting\n\nThe [issue tracker][issue-tracker] intends to manage and compile bugs,\nenhancements, proposals and tasks. Reading through its material or reporting to\nits contributors via the platform is strongly recommended.\n\n## Contributing\n\nThis project adheres to [Semantic Versioning][semver] and to certain syntax\nconventions defined in [.editorconfig][editorconfig]. To get a list of changes\nrefer to the [CHANGELOG][changelog]. Only branches prefixed by *feature-*,\n*hotfix-*, or *release-* will be considered:\n\n  - Fork the project.\n  - Create your new branch: `git checkout -b feature-my-feature develop`\n  - Commit your changes: `git commit -am 'Added my new feature.'`\n  - Push the branch: `git push origin feature-my-feature`\n  - Submit a pull request.\n\n## Credits\n\nThis project is created by [marcbperez][author] and maintained by its\n[author][author] and contributors.\n\n## License\n\nThis project is licensed under the [Apache License Version 2.0][license].\n\n[author]: https://marcbperez.github.io\n[issue-tracker]: https://github.com/marcbperez/flask-reportservice/issues\n[editorconfig]: .editorconfig\n[changelog]: CHANGELOG.md\n[license]: LICENSE\n[semver]: http://semver.org\n[install-docker-compose]: https://docs.docker.com/compose/install/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcbperez%2Fflask-reportservice","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarcbperez%2Fflask-reportservice","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarcbperez%2Fflask-reportservice/lists"}