apertium-apy(1)

✨ NAME ✨

okay so apertium-apy(1) is the API server for machine translation and language analysis 💅 it's giving main character energy 👑

🎀 SYNOPSIS 🎀

apertium-apy [ pairs_path ]

bestie, pairs_path is the path to your installed Apertium pairs 🧚 all the modes files in that path get included, no cap 🫶

🦋 OPTIONS 🦋

• -h, --help — pulls up the help message and exits 💀
• -s NONPAIRS_PATH, --nonpairs-path NONPAIRS_PATH — path to the Apertium tree. only the non-translator debug modes get pulled in from here 🙈
• -l LANG_NAMES, --lang-names LANG_NAMES — path to the localised language names sqlite database (default = langNames.db) 🌈
• -f MISSING_FREQS, --missing-freqs MISSING_FREQS — path to the missing word frequency sqlite database (default = None) 📊
• -p PORT, --port PORT — the port the server runs on (default = 2737) 🔥
• -c SSL_CERT, --ssl-cert SSL_CERT — path to your SSL certificate 🔐
• -k SSL_KEY, --ssl-key SSL_KEY — path to your SSL key file 🗝️
• -t TIMEOUT, --timeout TIMEOUT — timeout for requests (default = 10) ⏰
• -j NUM_PROCESSES, --num-processes NUM_PROCESSES — how many processes to run (default = 1). use 0 and you get one http server per core, and each one runs all the available language pairs 🍓
• -d, --daemon — daemon mode! stdout and stderr get redirected to the files apertium-apy.log and apertium-apy.err. use it with --log-path 🦋
• -P LOG_PATH, --log-path LOG_PATH — where the log output files go in daemon mode. defaults to the local directory 📁
• -i MAX_PIPES_PER_PAIR, --max-pipes-per-pair MAX_PIPES_PER_PAIR — how many pipelines we can spin up per language pair (default = 1) 🧩
• -n MIN_PIPES_PER_PAIR, --min-pipes-per-pair MIN_PIPES_PER_PAIR — when pipelines shut down, keep at least this many open per language pair (default = 0) 🛟
• -u MAX_USERS_PER_PIPE, --max-users-per-pipe MAX_USERS_PER_PIPE — how many concurrent requests a pipeline can take before we think about spinning up a new one (default = 5) 👯
• -m MAX_IDLE_SECS, --max-idle-secs MAX_IDLE_SECS — if you set it, pipelines that haven't been used in this many seconds get shut down 😴
• -r RESTART_PIPE_AFTER, --restart-pipe-after RESTART_PIPE_AFTER — restarts a pipeline after it has handled this many requests (default = 1000) 🔄
• -v VERBOSITY, --verbosity VERBOSITY — logging verbosity 📣
• -V, --version — shows the APY version and exits 🏷️
• -S, --scalemt-logs — generates ScaleMT-like logs. use it with --log-path. the page says it also disables something right there and then just... stops 😭 so no clue what gets disabled
• -M UNKNOWN_MEMORY_LIMIT, --unknown-memory-limit UNKNOWN_MEMORY_LIMIT — keeps unknown words in memory until a limit is reached. use it with --missing-freqs (default = 1000) 🧠
• -T STAT_PERIOD_MAX_AGE, --stat-period-max-age STAT_PERIOD_MAX_AGE — how many seconds back the request timing stats go (default = 3600) ⏳
• -wp WIKI_PASSWORD, --wiki-password WIKI_PASSWORD — Apertium Wiki account password for SuggestionHandler 🔑
• -wu WIKI_USERNAME, --wiki-username WIKI_USERNAME — Apertium Wiki account username for SuggestionHandler 🧑‍💻
• -b, --bypass-token — ReCAPTCHA bypass token 🫣
• -rs RECAPTCHA_SECRET, --recaptcha-secret RECAPTCHA_SECRET — ReCAPTCHA secret for suggestion validation 🤖
• -md MAX_DOC_PIPES, --max-doc-pipes MAX_DOC_PIPES — how many concurrent document translation pipelines we allow (default = 3) 📄
• -C CONFIG, --config CONFIG — configuration file to load options from 🗂️
• -ak API_KEYS, --api-keys API_KEYS — configuration file to load API keys 🪪

🌸 Homepage 🌸

the project lives over at https://github.com/apertium/apertium-apy 🦋

ok that's the tea ☕ this page was last touched on 2018-11-08 for apertium-apy(1) 💖 go forth and translate, bestie 🧚✨