{"id":21071262,"url":"https://github.com/yisuschrist/py_ao3","last_synced_at":"2025-04-30T15:40:59.033Z","repository":{"id":251262609,"uuid":"836810683","full_name":"YisusChrist/py_ao3","owner":"YisusChrist","description":"TUI application to pretty print information about your favorite AO3 fics","archived":false,"fork":false,"pushed_at":"2025-04-21T18:57:47.000Z","size":273,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T19:48:06.206Z","etag":null,"topics":["ao3","archive-of-our-own","python","python-textual","python3","textual","textualize","tui"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/YisusChrist.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-08-01T15:52:07.000Z","updated_at":"2025-04-21T18:57:49.000Z","dependencies_parsed_at":"2024-08-11T01:25:45.880Z","dependency_job_id":"48224557-e384-4ad7-9f22-a6a282f63768","html_url":"https://github.com/YisusChrist/py_ao3","commit_stats":null,"previous_names":["yisuschrist/py_ao3"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YisusChrist%2Fpy_ao3","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YisusChrist%2Fpy_ao3/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YisusChrist%2Fpy_ao3/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YisusChrist%2Fpy_ao3/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YisusChrist","download_url":"https://codeload.github.com/YisusChrist/py_ao3/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251733449,"owners_count":21634971,"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":["ao3","archive-of-our-own","python","python-textual","python3","textual","textualize","tui"],"created_at":"2024-11-19T18:51:07.639Z","updated_at":"2025-04-30T15:40:58.984Z","avatar_url":"https://github.com/YisusChrist.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/issues\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/issues/YisusChrist/py_ao3?color=171b20\u0026label=Issues%20%20\u0026logo=gnubash\u0026labelColor=e05f65\u0026logoColor=ffffff\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/forks\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/forks/YisusChrist/py_ao3?color=171b20\u0026label=Forks%20%20\u0026logo=git\u0026labelColor=f1cf8a\u0026logoColor=ffffff\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/stargazers\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/stars/YisusChrist/py_ao3?color=171b20\u0026label=Stargazers\u0026logo=octicon-star\u0026labelColor=70a5eb\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/actions\"\u003e\n        \u003cimg alt=\"Tests Passing\" src=\"https://github.com/YisusChrist/py_ao3/actions/workflows/github-code-scanning/codeql/badge.svg\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/pulls\"\u003e\n        \u003cimg alt=\"GitHub pull requests\" src=\"https://img.shields.io/github/issues-pr/YisusChrist/py_ao3?color=0088ff\"\u003e\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003c/a\u003e\n    \u003ca href=\"https://opensource.org/license/GPL-3.0/\"\u003e\n        \u003cimg alt=\"License\" src=\"https://img.shields.io/github/license/YisusChrist/py_ao3?color=0088ff\"\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/issues/new?assignees=YisusChrist\u0026labels=bug\u0026projects=\u0026template=bug_report.yml\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/issues/new?assignees=YisusChrist\u0026labels=feature\u0026projects=\u0026template=feature_request.yml\"\u003eRequest Feature\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/issues/new?assignees=YisusChrist\u0026labels=question\u0026projects=\u0026template=question.yml\"\u003eAsk Question\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/YisusChrist/py_ao3/security/policy#reporting-a-vulnerability\"\u003eReport security bug\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n![Alt](https://repobeats.axiom.co/api/embed/cd9239ab8f98edef7010a72b2a01492ea28060de.svg \"Repobeats analytics image\")\n\n\u003cbr\u003e\n\n`py_ao3` is a Python script that allows you to backup your GitHub repositories in a simple and fast way.\n\n\u003cdetails\u003e\n\u003csummary\u003eTable of Contents\u003c/summary\u003e\n\n- [Requirements](#requirements)\n- [Installation](#installation)\n  - [From PyPI](#from-pypi)\n  - [Manual installation](#manual-installation)\n  - [Uninstall](#uninstall)\n- [Usage](#usage)\n  - [Example of execution](#example-of-execution)\n- [Contributors](#contributors)\n  - [How do I contribute to py_ao3?](#how-do-i-contribute-to-py_ao3)\n- [License](#license)\n- [Credits](#credits)\n\n\u003c/details\u003e\n\n## Requirements\n\nHere's a breakdown of the packages needed and their versions:\n\n- [poetry](https://pypi.org/project/poetry) \u003e= 1.7.1 (_only for manual installation_)\n- [chardet](https://pypi.org/project/chardet) \u003e= 5.2.0\n- [matplotlib](https://pypi.org/project/matplotlib) \u003e= 3.9.1\n- [rich](https://pypi.org/project/rich) \u003e= 13.7.1\n- [textual](https://pypi.org/project/textual) \u003e= 0.74.0\n\n\u003e [!NOTE]\n\u003e The software has been developed and tested using Python `3.12.1`. The minimum required version to run the software is Python 3.6. Although the software may work with previous versions, it is not guaranteed.\n\n## Installation\n\n### From PyPI\n\n`py_ao3` can be installed easily as a PyPI package. Just run the following command:\n\n```bash\npip3 install py_ao3\n```\n\n\u003e [!IMPORTANT]\n\u003e For best practices and to avoid potential conflicts with your global Python environment, it is strongly recommended to install this program within a virtual environment. Avoid using the --user option for global installations. We highly recommend using [pipx](https://pypi.org/project/pipx) for a safe and isolated installation experience. Therefore, the appropriate command to install `py_ao3` would be:\n\u003e\n\u003e ```bash\n\u003e pipx install py_ao3\n\u003e ```\n\nThe program can now be ran from a terminal with the `py_ao3` command.\n\n### Manual installation\n\nIf you prefer to install the program manually, follow these steps:\n\n\u003e [!WARNING]\n\u003e This will install the version from the latest commit, not the latest release.\n\n1. Download the latest version of [py_ao3](https://github.com/YisusChrist/py_ao3) from this repository:\n\n   ```bash\n   git clone https://github.com/YisusChrist/py_ao3\n   cd py_ao3\n   ```\n\n2. Install the package:\n\n   ```bash\n   poetry install --only main\n   ```\n\n3. Run the program:\n\n   ```bash\n   poetry run py_ao3\n   ```\n\n### Uninstall\n\nIf you installed it from PyPI, you can use the following command:\n\n```bash\npipx uninstall py_ao3\n```\n\n## Usage\n\nTo run the program, simply execute the following command:\n\n```bash\npy_ao3\n```\n\nIn order to use the program, you must have a valid text file that contains the information of the stories you want to process. The file must be in the following format:\n\n```md\n_[TITLE]_\n\n- [CHARACTERS] ([SERIES])\n\n- by [[AUTHOR]]([AUTHOR_URL]) → [WORDS]\n\n- [RATING][COMMENT]\n```\n\nAs you may see, Markdown syntax is used to format the text file, so the program will read the file and process the information accordingly. You are free to pass any text file you want, as long as it follows the format above.\n\n### Example of execution\n\nhttps://github.com/user-attachments/assets/2ce55013-a285-40dc-9843-5e5fa9892439\n\n## Contributors\n\n\u003ca href=\"https://github.com/YisusChrist/py_ao3/graphs/contributors\"\u003e\u003cimg src=\"https://contrib.rocks/image?repo=YisusChrist/py_ao3\" /\u003e\u003c/a\u003e\n\n### How do I contribute to py_ao3?\n\nBefore you participate in our delightful community, please read the [code of conduct](https://github.com/YisusChrist/.github/blob/main/CODE_OF_CONDUCT.md).\n\nI'm far from being an expert and suspect there are many ways to improve – if you have ideas on how to make the configuration easier to maintain (and faster), don't hesitate to fork and send pull requests!\n\nWe also need people to test out pull requests. So take a look through [the open issues](https://github.com/YisusChrist/py_ao3/issues) and help where you can.\n\nSee [Contributing Guidelines](https://github.com/YisusChrist/.github/blob/main/CONTRIBUTING.md) for more details.\n\n## License\n\n`py_ao3` is released under the [GPL-3.0 License](https://opensource.org/license/GPL-3.0).\n\n## Credits\n\n\u003e [!NOTE]\n\u003e Thanks to the [Textualize](https://github.com/Textualize) team for the [textual](https://github.com/Textualize/textual) TUI framework, which was a great inspiration for me to develop this project.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyisuschrist%2Fpy_ao3","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyisuschrist%2Fpy_ao3","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyisuschrist%2Fpy_ao3/lists"}