{"id":31974428,"url":"https://github.com/sphamba/classyfire","last_synced_at":"2026-07-21T15:01:48.164Z","repository":{"id":312560367,"uuid":"1022231547","full_name":"sphamba/classyfire","owner":"sphamba","description":"Quickly annotate, tag, and browse your collection of research articles.","archived":false,"fork":false,"pushed_at":"2025-09-14T08:06:07.000Z","size":105,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-24T07:40:32.295Z","etag":null,"topics":["annotation","litterature-review","research"],"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/sphamba.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"ko_fi":"sphamba"}},"created_at":"2025-07-18T17:19:23.000Z","updated_at":"2025-09-14T08:06:11.000Z","dependencies_parsed_at":"2025-08-31T15:34:02.229Z","dependency_job_id":"36dea136-b9c3-449e-b91a-b2690aad2b92","html_url":"https://github.com/sphamba/classyfire","commit_stats":null,"previous_names":["sphamba/classyfire"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/sphamba/classyfire","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphamba%2Fclassyfire","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphamba%2Fclassyfire/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphamba%2Fclassyfire/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphamba%2Fclassyfire/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphamba","download_url":"https://codeload.github.com/sphamba/classyfire/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphamba%2Fclassyfire/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35727912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-07-20T02:08:10.276Z","status":"online","status_checked_at":"2026-07-21T02:00:06.728Z","response_time":109,"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":["annotation","litterature-review","research"],"created_at":"2025-10-14T20:12:44.283Z","updated_at":"2026-07-21T15:01:47.918Z","avatar_url":"https://github.com/sphamba.png","language":"Python","funding_links":["https://ko-fi.com/sphamba"],"categories":[],"sub_categories":[],"readme":"# ClassyFire 🔥\n\n_Quickly annotate, tag, and browse your collection of research articles._\n\nMade with Python and [Streamlit](https://streamlit.io/). Try the [Live Demo](https://classyfire.streamlit.app/)!\n\n## Features\n\n- Online access on desktop and mobile\n- Markdown annotations\n- Tags with categories and associated pages\n- Filtering\n\n\u003cimg width=\"400\" alt=\"Annotations and tags\" src=\"https://github.com/user-attachments/assets/6c3fcbc2-9b1e-4825-a309-839729d83269\" /\u003e\n\u003cimg alt=\"Dynamic table\" src=\"https://github.com/user-attachments/assets/f7fbe037-a516-4be5-a1bd-909ba858a415\" /\u003e\n\n## Requirements\n\n- Python 3.13 or higher\n- [uv](https://docs.astral.sh/uv/getting-started/installation/) Python package and project manager\n- Make\n\n\n## Deploying the website locally\n\nFollow these instructions to run Classy Fire locally. First, run:\n\n```bash\nmake install\n```\n\nThen, edit the `.env` file in the root directory of the repository with the following content:\n\n```env\nCLASSYFIRE_LANG=en  # \"en\" or \"fr\"\n```\n\n\nFinally, run:\n\n```bash\nmake run\n```\n\nThe website will be available at [http://localhost:8501](http://localhost:8501).\n\n\n## Importing CSV data\n\nTo import CSV data, run the following command:\n\n```bash\nuv run classyfire/scripts/import_csv.py \u003cpath-to-csv-file\u003e\n```\n\n\n## Deployment\n\n\u003cdetails\u003e\n\u003csummary\u003eTips for manual deployment\u003c/summary\u003e\n\n### Service\n\nCreate the file `classyfire.service`:\n```ini\n[Unit]\nDescription=ClassyFire server\nAfter=network.target\n\n[Service]\nType=simple\nWorkingDirectory=/path/to/classyfire/root\nExecStart=/usr/bin/make run\nRestart=always\nRestartSec=5\nEnvironment=PATH=/usr/local/bin:/usr/bin:/bin:/path/to/uv/dir\n\n[Install]\nWantedBy=multi-user.target\n```\nMake sure the `Environment` contains the path to the directory that contains the `uv` executable (shown by `which uv`)\n\nCopy or link the file to `/etc/systemd/system/classyfire.service`:\n```bash\nsudo ln -s /path/to/classyfire/root/classyfire.service /etc/systemd/system/classyfire.service\n```\n\nEnable and start the service:\n```bash\nsudo systemctl daemon-reload\nsudo systemctl enable classyfire.service\nsudo systemctl start classyfire.service\nsudo systemctl status classyfire.service\njournalctl -u classyfire.service -f\n```\n\n\n### Database backup\n\nRun\n```bash\ncrontab -e\n```\n\nAppend the lines:\n```bash\n# Classyfire backups\n# Daily (midnight)\n0 0 * * * cp /absolute/path/to/db.json /absolute/path/to/backups/01_db_daily.json\n# Weekly (Sunday midnight)\n0 0 * * 0 cp /absolute/path/to/db.json /absolute/path/to/backups/02_db_weekly.json\n# Monthly (1st day of month midnight)\n0 0 1 * * cp /absolute/path/to/db.json /absolute/path/to/backups/03_db_monthly.json\n# Every 3 months (January, April, July, October 1st at midnight)\n0 0 1 1,4,7,10 * cp /absolute/path/to/db.json /absolute/path/to/backups/04_db_quarterly.json\n```\n\nCheck with\n```bash\ncrontab -l\n```\n\u003c/details\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphamba%2Fclassyfire","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphamba%2Fclassyfire","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphamba%2Fclassyfire/lists"}