{"id":23452270,"url":"https://github.com/kulmajaba/visitor-bot","last_synced_at":"2025-04-10T16:55:34.706Z","repository":{"id":179158106,"uuid":"288017558","full_name":"kulmajaba/visitor-bot","owner":"kulmajaba","description":"Telegram bot for recording visitors to a space","archived":false,"fork":false,"pushed_at":"2020-08-24T08:51:12.000Z","size":37,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T20:41:25.491Z","etag":null,"topics":["telegram","telegram-bot"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kulmajaba.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":"2020-08-16T20:15:31.000Z","updated_at":"2021-12-09T11:52:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"c1ee89db-fac2-4610-befe-75846c33d299","html_url":"https://github.com/kulmajaba/visitor-bot","commit_stats":null,"previous_names":["kulmajaba/visitor-bot"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kulmajaba%2Fvisitor-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kulmajaba%2Fvisitor-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kulmajaba%2Fvisitor-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kulmajaba%2Fvisitor-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kulmajaba","download_url":"https://codeload.github.com/kulmajaba/visitor-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248257865,"owners_count":21073815,"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":["telegram","telegram-bot"],"created_at":"2024-12-24T01:14:20.070Z","updated_at":"2025-04-10T16:55:34.696Z","avatar_url":"https://github.com/kulmajaba.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Visitorbot\n\nTelegram bot for recording visitors to a space.\n* Easy usage through Telegram: register with your name and email, after that use the buttons to sign yourself in or out.\n* Deletes records older that 30 days automatically\n* Allows a single admin user to get a CSV file containing all visits from the past 30 days via Telegram.\n\n## Setup\n\nThe backend is built using Docker and docker-compose, but should be possible to run without Docker as well. The implementation is done with Python 3.8.5 using PostgreSQL 12\n\nCopy or rename the `.env.sample` file to the same folder as `.env` and fill in the missing information.\n\n| Variable          | Description |\n| ----------------- | ----------- |\n| BOT_ORGANIZATION  | The name of the organization the bot belongs to, currently only used for report file names. |\n| PYTZ_TIMEZONE     | Timezone used by Python, use valid Pytz timezones. E.g. Europe/Helsinki. You'll probably want to match the database timezones. |\n| TZ                | Postgres timezone. |\n| PGTZ              | Postgres default timezone. |\n| TG_TOKEN          | Telegram API token for the bot. |\n| TG_ADMIN_ID       | Telegram user ID (not username) of the admin, enables the ability to fetch reports. Use e.g. [@userinfobot](https://t.me/userinfobot) to get your ID. |\n| POSTGRES_DB       | Postgres database name. Used by both PostgreSQL and Python code. |\n| POSTGRES_USER     | Postgres user for DB access. Same as above. |\n| POSTGRES_PASSWORD | Postgres user password. Same as above. |\n| POSTGRES_HOST     | Hostname for the Python code to use when connecting to the DB, use `db` for Docker installations with the default docker-compose file |\n| POSTGRES_PORT     | Postgres port, used by both PostgreSQL and Python code. |\n| POSTGRES_TABLE_USER | Table name for the users of the bot, use `visitor_user` for installations with the default database initialization |\n| POSTGRES_TABLE_VISIT | Table name for the visits, use `visit` for installations with the default database initialization |\n\nAfter that, you should be able to build and run the bot with `docker-compose up -d`. Add `--build` to rebuild images and/or `--force-recreate` to recreate the application containers.\n\nCheck logs with `docker-compose logs`, `-f` to follow, shut down with `docker-compose down`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkulmajaba%2Fvisitor-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkulmajaba%2Fvisitor-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkulmajaba%2Fvisitor-bot/lists"}