{"id":27021732,"url":"https://github.com/hmknapp/taxi","last_synced_at":"2026-01-19T02:32:07.749Z","repository":{"id":229224153,"uuid":"291026249","full_name":"HMKnapp/taxi","owner":"HMKnapp","description":"TAXI - Translation Automation eXchange Interface","archived":false,"fork":false,"pushed_at":"2020-06-19T09:58:27.000Z","size":123,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-04T19:54:29.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":false,"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/HMKnapp.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}},"created_at":"2020-08-28T11:11:06.000Z","updated_at":"2020-08-28T11:11:08.000Z","dependencies_parsed_at":"2024-03-22T21:45:42.793Z","dependency_job_id":null,"html_url":"https://github.com/HMKnapp/taxi","commit_stats":null,"previous_names":["hmknapp/taxi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/HMKnapp/taxi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMKnapp%2Ftaxi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMKnapp%2Ftaxi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMKnapp%2Ftaxi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMKnapp%2Ftaxi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HMKnapp","download_url":"https://codeload.github.com/HMKnapp/taxi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HMKnapp%2Ftaxi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28558229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-19T00:46:33.223Z","status":"online","status_checked_at":"2026-01-19T02:00:08.049Z","response_time":67,"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":[],"created_at":"2025-04-04T19:52:09.613Z","updated_at":"2026-01-19T02:32:07.734Z","avatar_url":"https://github.com/HMKnapp.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# TAXI - Proof of Concept\n**TAXI** stands for *Translation Automation eXchange Interface*.\n\n## Setup\n### Dependencies\n```sh\ngem install bundler:2.1.4\nbundle install\n```\n\n## Run\n```sh\nDEV_ENV=true bundle exec bin/taxi --help\n```\nSetting the environment variable `DEV_ENV` will load `.env` at startup.\n\n## Translations\n\n### Stages and Structure\nThere are 3 stages in the translation workflow:\n1. **open**: ready to be translated by the translation agency\n2. **deploy**: translated and ready to be deployed\n3. **done**: deployed in production\n\n\nOverall file structure:\n```\nSFTP/\n- user1/\n  - 1_open/\n  - 2_deploy/\n  - 3_done/\n- user2/\n  - 1_open/\n  - 2_deploy/\n  - 3_done/\n```\n\nFor each category, a folder in the format `\u003cname\u003e-\u003cfrom\u003e-\u003cto\u003e` has to be present:\n```\n- 1_open/\n  - \u003cname\u003e-\u003cfrom\u003e-\u003cto\u003e-\u003cdate\u003e/\n  - wirecard-en_US-ru_RU-20200506/\n```\n\n\nSo the complete identifier for a *package* is `\u003cname\u003e-\u003cfrom\u003e-\u003cto\u003e-\u003cdate\u003e`, where the root folder `open` is the status.\n\n### Example Workflow\n\nUsing `taxi`, an example workflow would be:\n1. `taxi package make`\n2. `taxi package translate`\n3. Translation (or `taxi package mv` for testing purposes)\n4. `taxi package deploy`\n\nYou can use `taxi package status all|open|deploy|done` to check the status of packages.\n\n### Commands\n#### package make\n```sh\ntaxi package make \u003cname\u003e \u003cpath\u003e [--bucket=\u003cbucket\u003e]\n```\n\nArguments:\n* `name`: name of the package (free to choose any name)\n* `path`: path to the resources on S3 (results in `s3://\u003cbucket\u003e/\u003cpath\u003e`)\n* **OPTIONAL** `bucket`: name of the bucket (*Default:*  `$AWS_DEFAULT_BUCKET`)\n\n#### package translate\n```sh\ntaxi package translate \u003cname\u003e [\u003cfrom\u003e] \u003cto\u003e --agency=\u003cagency\u003e\n```\n\nArguments:\n* `name`: name of the package (must match the `name` specified in `package make`)\n* **OPTIONAL** `from`: original language (*Default: en_US*)\n* `to`: target language (*e.g. ru_RU*)\n* `agency`: name of the agency which will get the translation package (AKA user name for SFTP)\n\n#### package deploy\n```sh\ntaxi package deploy \u003cname\u003e \u003cpath\u003e [\u003cfrom\u003e] \u003cto\u003e [--bucket=\u003cbucket\u003e] --agency=\u003cagency\u003e\n```\n\nArguments:\n* `name`: name of the package (must match the `name` specified in `package make`)\n* `path`: path to the resources on S3 (results in `s3://\u003cbucket\u003e/\u003cpath\u003e`)\n* **OPTIONAL** `from`: original language (*Default: en_US*)\n* `to`: target language (*e.g. ru_RU*)\n* **OPTIONAL** `bucket`: name of the bucket (*Default:* `$AWS_DEFAULT_BUCKET`)\n* `agency`: name of the agency which translated the package (AKA user name for SFTP)\n\n#### status\n```sh\ntaxi package status \u003cphase\u003e --agency=\u003cagency\u003e\n```\n\nArguments:\n* `phase`: one of `open`, `deploy`, `done` or `all`\n* `agency`: name of the agency (AKA user name for SFTP)\n\n## Dev Environment\nThis section describes the setup of a development environment.\n\n### Setup\n\n**Run once:** Generate SSH keys for the users and setup folder structure\n```sh\ncd dev/\n./init.sh\n```\n\n**Start infrastructure**\n```sh\ndocker-compose -f dev/docker-compose.yml up\n```\n\n**Stop infrastructure**\n```sh\ndocker-compose -f dev/docker-compose.yml down --remove-orphans\n```\n\n### Access\n\n#### SFTP server\nLogin via Terminal, e.g. as agency2\n```sh\nsftp -P 2222 -oUserKnownHostsFile=/dev/null -oStrictHostKeyChecking=no -i dev/sftp-keys/agency2/rsa_key agency2@localhost\n```\n\n#### S3 Bucket Web Interface\nAccess the Administration Interface\n```sh\nopen http://localhost:9000\n```\n\n#### S3 Bucket Webserver\nDirectly access files in your-bucket through the webserver\n```\nopen http://localhost:8888/your-name/path/to/document\n```\n\n### AWS CLI\nAWS CLI setup for minio, see https://docs.min.io/docs/aws-cli-with-minio.html\nThe credentials that need to be used for `aws configure --profile minio-admin` are:\n* Access Key ID: `minio`\n* Secret Access Key: `letmeinplease`\n* Region: eu-central-1\n\nThe credentials that need to be used for `aws configure --profile minio` are:\n* Access Key ID: `myuser`\n* Secret Access Key: `myuserletmein`\n* Region: eu-central-1\n\n#### Sample Configuration\nAdd to your `~/.aws/config`\n```\n[profile minio]\nregion = eu-central-1\noutput = text\nsignature_version = s3v4\n\n[profile minio-myuser]\nsource_profile = minio\nregion = eu-central-1\noutput = text\n```\n\nAdd to your `~/.aws/credentials`\n```\n[minio]\naws_access_key_id = minio\naws_secret_access_key = letmeinplease\n\n[minio-myuser]\naws_access_key_id = myuser\naws_secret_access_key = myuserletmein\n```\n\nOnce the AWS CLI has been configured, create a bucket:\n1. First, create a bucket\n```sh\naws s3 --endpoint-url http://localhost:9000 --profile minio mb s3://mybucket\n```\n2. Then, upload documents\n```sh\naws s3 --endpoint-url http://localhost:9000 --profile minio cp /tmp/build/html s3://mybucket --recursive\n```\n3. List the documents just created\n```sh\naws s3 --endpoint-url http://localhost:9000 --profile minio ls s3://mybucket\n```\n\n**Assume Role**\n\nTest the configuration:\n```sh\naws --endpoint-url http://localhost:9000 --profile minio sts assume-role --role-arn arn:xxx:xxx:xxx:xxxx --role-session-name term_session --output json\n```\n\n\n### Development\nAt this point, both the SFTP server and the S3 clone are up and running.\nYou may create more buckets and add more content at this point.\n`taxi` will use the environment variables specified in `.env` if `DEV_ENV=1`.\nThese variables will set up `taxi` to use the local infrastructure from `dev/docker-compose.yml`.\n\nCheck the status of source code documentation by running:\n```sh\nbundle exec rake doc:suggest\n```\n\n### TODO\n* [x] SFTP: Add multiple users (via `users.conf`)\n* [ ] SFTP: Mount user config file for users, and generate the keys according to the user names in that config\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmknapp%2Ftaxi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhmknapp%2Ftaxi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhmknapp%2Ftaxi/lists"}