{"id":13668207,"url":"https://github.com/schemen/privacycow","last_synced_at":"2025-04-13T19:24:35.859Z","repository":{"id":83808722,"uuid":"374972403","full_name":"schemen/privacycow","owner":"schemen","description":"Mailcow Privacy Alias CLI","archived":false,"fork":false,"pushed_at":"2023-07-25T12:19:57.000Z","size":24,"stargazers_count":14,"open_issues_count":2,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-27T10:06:54.340Z","etag":null,"topics":["hacktoberfest","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/schemen.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-06-08T10:42:19.000Z","updated_at":"2023-08-23T05:52:30.000Z","dependencies_parsed_at":"2024-08-02T08:03:50.505Z","dependency_job_id":null,"html_url":"https://github.com/schemen/privacycow","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schemen%2Fprivacycow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schemen%2Fprivacycow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schemen%2Fprivacycow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schemen%2Fprivacycow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schemen","download_url":"https://codeload.github.com/schemen/privacycow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248766765,"owners_count":21158314,"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":["hacktoberfest","python"],"created_at":"2024-08-02T08:00:24.437Z","updated_at":"2025-04-13T19:24:35.830Z","avatar_url":"https://github.com/schemen.png","language":"Python","funding_links":[],"categories":["Table of contents"],"sub_categories":["Other"],"readme":"# privacycow\n\n## Install\n\n```console\npython3 -m pip install git+https://github.com/schemen/privacycow.git#egg=privacycow\n```\n\n### In \"developer mode\" (editable):\n\n\nusing a virtualenv:\n```console\nvirtualenv venv -p python3\nsource venv/bin/activate\npython -m pip install -e .\n```\n\nor\n```console\npython3 -m venv venv\nsource venv/bin/activate\npython -m pip install git+ssh://git@github.com:schemen/privacycow.git#egg=privacycow\n```\n\n```x-sh\ngit clone https://github.com/schemen/privacycow.git \u0026\u0026 cd privacycow\nvirtualenv venv -p python3\nsource venv/bin/activate\npip install -r requirements.txt\ndeactivate\n\n```\n\n### First run, Adjust settings, see options further down\n\n```\n# configure your config.ini\n# run privacycow once, it will create a sample config file at\n# ~/.config/privacycow/config.ini\nprivacycow \u0026\u0026 vim ~/.config/privacycow/config.ini\n\n```\n## Config\nHave a look at `config.ini.example` for the sample configuration\n\n```\n[DEFAULT]\n# The default domain used as an alias domain. I recommend purchasing an\n# unrelated domain and adding it to your Mailcow installation. Alternatively\n# you can just use your main domain.\nRELAY_DOMAIN = example.com \n# The address emails will go to if a GOTO is not defined in the\n# [$RELAY_DOMAIN] settings section.\nGOTO = user@example.com\n# These two settings should be self explanatory and will be used if\n# there is not a MAILCOW_API_KEY or MAILCOW_INSTANCE setting in the\n# [$RELAY_DOMAIN] settings section.\nMAILCOW_API_KEY = api_key\nMAILCOW_INSTANCE = https://mail.example.com\n\n[example.com]\n# The settings to be used when example.com is RELAY_DOMAIN.  RELAY_DOMAIN\n# in the [DEFAULT] section is defining this section as the default.\n# All three parameters are optional here as if they are not defined\n# the setting from DEFAULT will be used instead.\nGOTO = another@example.com\nMAILCOW_API_KEY = another_api_key\nMAILCOW_INSTANCE = https://mail.example.com\n\n[example.org]\n# These settings can be used by calling privacycow like this:\n# RELAY_DOMAIN=example.org privacycow list\nGOTO = user@example.org\n# Note we have chosen not to define MAILCOW_API_KEY and\n# MAILCOW_INSTANCE here so the values in [DEFAULT] will be used instead.\n\n\n```\n\n## Usage\n```\n➜  privacycow     \nUsage: privacycow [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  --debug / --no-debug\n  --help                Show this message and exit.\n\nCommands:\n  add      Create a new random alias.\n  delete   Delete a alias.\n  disable  Disable a alias, done by setting the \"Silently Discard\" option.\n  enable   Enable a alias, which disables \"Silently Discard\".\n  list     Lists all aliases with the configured privacy domain.\n\n```\n\n\n## Examples\n\n```\n➜  privacycow add -c \"terrible place\"\nSuccess! The following Alias has been created:\nAlias ID:       29\nAlias Email:    5b25SxYx9J46lJjk.YVuONdYUUA3ekAgU@privacycow.com\nAlias Comment:  terrible place\n\n\n➜  privacycow disable 29             \nSuccess! The following Alias disabled:\nAlias ID:       29\nAlias Email:    5b25SxYx9J46lJjk.YVuONdYUUA3ekAgU@privacyfwd.ch\n\n\n\n➜  privacycow list      \nID                        Alias                           Comment       Active \n===============================================================================\n22   pQf6qmgMxpa8C.c1Q3sdpDZarqf4ggCe2@privacycow.com  bad actor        Active \n28   mX4WjTjHcJwa96Vk.xEKpPKbgArysoWvg@privacycow.com  test             Active \n29   5b25SxYx9J46lJjk.YVuONdYUUA3ekAgU@privacycow.com  terrible place   Discard\n\n``` \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschemen%2Fprivacycow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschemen%2Fprivacycow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschemen%2Fprivacycow/lists"}