{"id":16096350,"url":"https://github.com/sio/issyours","last_synced_at":"2025-04-05T20:29:35.899Z","repository":{"id":101312793,"uuid":"202126347","full_name":"sio/issyours","owner":"sio","description":"Read-only archive for any issue tracker","archived":false,"fork":false,"pushed_at":"2019-11-06T11:13:56.000Z","size":708,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-11T20:49:53.607Z","etag":null,"topics":["issue-management","pelican","pelican-plugin","pelican-plugins","python","static-site-generator"],"latest_commit_sha":null,"homepage":"https://issyours.ml","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sio.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}},"created_at":"2019-08-13T11:06:22.000Z","updated_at":"2025-01-23T23:27:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"4a41d070-240f-4bf9-8844-3c77de94d455","html_url":"https://github.com/sio/issyours","commit_stats":{"total_commits":215,"total_committers":1,"mean_commits":215.0,"dds":0.0,"last_synced_commit":"dcd4d0c0e9fc76f612084501be04f4cb2c200cd9"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sio%2Fissyours","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sio%2Fissyours/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sio%2Fissyours/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sio%2Fissyours/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sio","download_url":"https://codeload.github.com/sio/issyours/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247398104,"owners_count":20932664,"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":["issue-management","pelican","pelican-plugin","pelican-plugins","python","static-site-generator"],"created_at":"2024-10-09T17:13:39.191Z","updated_at":"2025-04-05T20:29:35.864Z","avatar_url":"https://github.com/sio.png","language":"Python","readme":"# Read-only archive for any issue tracker\n\n## Project status\n\nMinimum viable product. You can already use Issyours to create usable HTML\narchive for GitHub issues.\n\nBreaking changes in configuration files are unlikely, but not impossible.\nYou should test that new version works for you if updating.\n\n\n## Overview\n\nThis project aims to enable developers to own the data they submit to an issue\ntracker. Issyours offers more than just a data dump for backup purposes, it\ncreates fully browsable issues archive ready to be deployed as a static web\nsite (see [demo](https://issyours.ml/demo/issues)).\n\nIssyours currently supports exporting GitHub Issues and Pull Requests and\nrendering them with Pelican static site generator. More data sources are to be\nsupported, the project was meant to be easily extensible from day one.\n\nThe core components of Issyours work as layers:\n\n- *Fetcher* obtains raw data from issue tracker and saves in to a persistent\n  *Storage*\n- *Reader* provides an uniform API for reading issue data from *Storage*\n- *Renderer* creates a static web site for viewing issues available via\n  *Reader*\n\nFeature highlights:\n\n- Backup utility for GitHub issues (requires oAuth token)\n- Pelican plugin for rendering issues on a static web site\n    - Highly customizable destination paths and URLs\n    - Multiple data sources (with different prefixes)\n    - Customizable URL rewrite rules for links in issues/comments (regular\n      expressions)\n- Python library for adding support of other issue trackers\n- A functional, clean and responsive default theme based on Bootstrap 4\n\n\n## Installation\n\nIssyours can be installed with pip:\n\n```\npip install \"https://github.com/sio/issyours/tarball/master\"\n```\n\nThat provides you with Python packages for `issyours` and `issyours_github`\nand a command line application `issyours-github`.\n\nTo fetch default theme along with the main package use:\n\n```\npip install \"https://github.com/sio/issyours/tarball/master[with-default-theme]\"\n```\n\n\n## Usage\n\nIssyours is an plugin for Pelican. Refer to [Pelican documentation] for\nintroductory overview. All configuration happens within Pelican settings file\n([sample]).\n\nEnable Issyours plugin:\n\n```python\nimport issyours.pelican\nPLUGINS = [issyours.pelican]\n```\n\nConfigure at least one data source:\n\n```python\nfrom issyours_github import GitHubReader\nISSYOURS_SOURCES = {\n    GitHubReader(repo='...', directory='...'): None,\n}\n```\n\nAfter configuring Pelican and Issyours run `pelican $BLOG_CONTENT -o\n$SITE_OUTPUT -s $CONFIG_FILE` to generate HTML pages for the static website.\n\nThese steps are explained with more details in\n[documentation](docs/quickstart.md)\n\n[Pelican documentation]: http://docs.getpelican.com/en/stable/\n[sample]: pelican_demo.py\n\n\n## Support and contributing\n\nIf you need help with using Issyours, please create\n**[an issue](https://github.com/sio/issyours/issues)**. Issues are also the\nprimary venue for reporting bugs and posting feature requests. General\ndiscussion related to this project is also acceptable and very welcome!\n\nIn case you wish to contribute code or documentation, feel free to open **[a\npull request](https://github.com/sio/issyours/pulls)**. That would certainly\nmake my day!\n\nI'm open to dialog and I promise to behave responsibly and treat all\ncontributors with respect. Please try to do the same, and treat others the way\nyou want to be treated.\n\nIf for some reason you'd rather not use the issue tracker, contacting me via\nemail is OK too. Please use a descriptive subject line to enhance visibility\nof your message. Also please keep in mind that public discussion channels are\npreferable because that way many other people may benefit from reading past\nconversations. My email is visible under the GitHub profile and in the commit\nlog.\n\n\n## License and copyright\n\nCopyright 2019 Vitaly Potyarkin\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU Affero General Public License as published by\n    the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU Affero General Public License for more details.\n\n    You should have received a copy of the GNU Affero General Public License\n    along with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n\n\n## Development roadmap\n\nSee [TODO list](TODO.md).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsio%2Fissyours","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsio%2Fissyours","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsio%2Fissyours/lists"}