{"id":13598406,"url":"https://github.com/FuzzyGrim/Yamtrack","last_synced_at":"2025-04-10T09:31:09.911Z","repository":{"id":64918379,"uuid":"576455465","full_name":"FuzzyGrim/Yamtrack","owner":"FuzzyGrim","description":"A self hosted media tracker.","archived":false,"fork":false,"pushed_at":"2024-04-13T17:00:31.000Z","size":1970,"stargazers_count":56,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"dev","last_synced_at":"2024-04-14T05:30:43.374Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","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/FuzzyGrim.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}},"created_at":"2022-12-09T22:58:21.000Z","updated_at":"2024-05-28T08:20:52.846Z","dependencies_parsed_at":"2023-09-27T02:03:43.703Z","dependency_job_id":"62a399b2-93f8-416e-b9ad-62f3c65d3296","html_url":"https://github.com/FuzzyGrim/Yamtrack","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuzzyGrim%2FYamtrack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuzzyGrim%2FYamtrack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuzzyGrim%2FYamtrack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FuzzyGrim%2FYamtrack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FuzzyGrim","download_url":"https://codeload.github.com/FuzzyGrim/Yamtrack/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248191679,"owners_count":21062551,"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":[],"created_at":"2024-08-01T17:00:52.326Z","updated_at":"2025-04-10T09:31:04.887Z","avatar_url":"https://github.com/FuzzyGrim.png","language":"Python","funding_links":[],"categories":["Python","Software","django","self-hosted"],"sub_categories":["Miscellaneous"],"readme":"# Yamtrack\n\n![App Tests](https://github.com/FuzzyGrim/Yamtrack/actions/workflows/app-tests.yml/badge.svg)\n![Docker Image](https://github.com/FuzzyGrim/Yamtrack/actions/workflows/docker-image.yml/badge.svg)\n![Image Size](https://ghcr-badge.egpl.dev/fuzzygrim/yamtrack/size?tag=dev)\n![CodeFactor](https://www.codefactor.io/repository/github/fuzzygrim/yamtrack/badge)\n![Codecov](https://codecov.io/github/FuzzyGrim/Yamtrack/branch/dev/graph/badge.svg?token=PWUG660120)\n![GitHub](https://img.shields.io/badge/license-GPL--3.0-blue)\n\nYamtrack is a self hosted media tracker for movies, tv shows, anime and manga.\n\nYou can try the app at [yamtrack.fuzzygrim.com](https://yamtrack.fuzzygrim.com) using the username `demo` and password `demo`.\n\n## Features\n\n- Track movies, tv shows, anime, manga and games\n- Track each season of a tv show individually and episodes watched\n- Save score, status, progress, repeats (rewatches, rereads...), start and end dates, or write a note.\n- Keep a tracking history with each action with a media, such as when you added it, when you started it, when you started watching it again, etc.\n- Use personal lists to organize your media for any purpose, add other members to collaborate on your lists.\n- Easy deployment with Docker via docker-compose with SQLite or PostgreSQL.\n- Multi-users functionality allowing individual accounts with personalized tracking.\n- Import from [MyAnimeList](https://myanimelist.net/), [The Movie Database](https://www.themoviedb.org/) and [AniList](https://anilist.co/).\n- Export all your tracked media to a CSV file and import it back.\n\n## Installing with Docker\n\nCopy the default `docker-compose.yml` file from the repository and set the environment variables. This would use a SQlite database, which is enough for most use cases.\n\nTo start the containers run:\n\n```bash\ndocker-compose up -d\n```\n\nAlternatively, if you need a PostgreSQL database, you can use the `docker-compose.postgres.yml` file.\n\n### Environment variables\n\n| Name            | Type   | Notes                                                                                                                                                                       |\n| --------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| TMDB_API        | String | The Movie Database API key for movies and tv shows, a default key is provided                                                                                               |\n| TMDB_NSFW       | Bool   | Default to false, set to true to include adult content in tv and movie searches                                                                                             |\n| TMDB_LANG       | String | TMDB metadata language, uses a Language code in ISO 639-1 e.g \"en\", for more specific results a country code in ISO 3166-1 can be added e.g \"en-US\"                         |\n| MAL_API         | String | MyAnimeList API key, for anime and manga, a default key is provided                                                                                                         |\n| MAL_NSFW        | Bool   | Default to false, set to true to include adult content in anime and manga searches                                                                                          |\n| IGDB_ID         | String | IGDB API key for games, a default key is provided but it's recommended to get your own as it has a low rate limit.                                                          |\n| IGDB_SECRET     | String | IGDB API secret for games, a default value is provided but it's recommended to get your own as it has a low rate limit.                                                     |\n| IGDB_NSFW       | Bool   | Default to false, set to true to include adult content in game searches                                                                                                     |\n| REDIS_URL       | String | Default to redis://localhost:6379, Redis is needed for processing background tasks, set this to your redis server url.                                                      |\n| SECRET          | String | [Secret key](https://docs.djangoproject.com/en/stable/ref/settings/#secret-key) used for cryptographic signing, should be a random string                                   |\n| ALLOWED_HOSTS   | List   | Host/domain names that this Django site can serve, set this to your domain name if exposing to the public                                                                   |\n| REGISTRATION    | Bool   | Default to true, set to false to disable user registration                                                                                                                  |\n| DEBUG           | Bool   | Default to false, set to true for debugging                                                                                                                                 |\n| PUID            | Int    | User ID for the app, default to 1000                                                                                                                                        |\n| PGID            | Int    | Group ID for the app, default to 1000                                                                                                                                       |\n| TZ              | String | Timezone, default to UTC                                                                                                                                                    |\n| WEB_CONCURRENCY | Int    | Number of webserver processes, default to 1 but it's recommended to have a value of [(2 x num cores) + 1](https://docs.gunicorn.org/en/latest/design.html#how-many-workers) |\n\n### Environment variables for PostgreSQL\n\n| Name        | Type   | Notes                        |\n| ----------- | ------ | ---------------------------- |\n| DB_HOST     | String | When not set, sqlite is used |\n| DB_PORT     | Int    |                              |\n| DB_NAME     | String |                              |\n| DB_USER     | String |                              |\n| DB_PASSWORD | String |                              |\n\n## Local development\n\nClone the repository and change directory to it.\n\n```bash\ngit clone https://github.com/FuzzyGrim/Yamtrack.git\ncd Yamtrack\n```\n\nInstall Redis or spin up a bare redis container:\n\n```bash\ndocker run -d --name redis -p 6379:6379 --restart unless-stopped redis:7-alpine\n```\n\nCreate a `.env` file in the root directory and add the following variables.\n\n```bash\nTMDB_API=API_KEY\nMAL_API=API_KEY\nIGDB_ID=IGDB_ID\nIGDB_SECRET=IGDB_SECRET\nSECRET=SECRET\nDEBUG=True\n```\n\nThen run the following commands.\n\n```bash\npython -m pip install -U -r requirements-dev.txt\ncd src\npython manage.py migrate\npython manage.py runserver \u0026 celery --app config worker -l DEBUG\n```\n\nGo to: http://localhost:8000\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFuzzyGrim%2FYamtrack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFuzzyGrim%2FYamtrack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFuzzyGrim%2FYamtrack/lists"}