{"id":22842812,"url":"https://github.com/atelierarith/docstringtranslation.jl","last_synced_at":"2025-06-25T01:42:47.562Z","repository":{"id":261701109,"uuid":"885064296","full_name":"AtelierArith/DocstringTranslation.jl","owner":"AtelierArith","description":"Translate docstrings in Julia into your preferred language.","archived":false,"fork":false,"pushed_at":"2025-06-02T11:07:01.000Z","size":348,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-02T21:46:12.587Z","etag":null,"topics":["julia","julialang","openai","openai-ap","translator"],"latest_commit_sha":null,"homepage":"https://atelierarith.github.io/DocstringTranslation.jl/","language":"Julia","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/AtelierArith.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,"zenodo":null},"funding":{"github":"terasakisatoshi"}},"created_at":"2024-11-07T22:19:12.000Z","updated_at":"2025-06-02T10:46:21.000Z","dependencies_parsed_at":"2024-11-08T00:29:07.368Z","dependency_job_id":"5ccc55b7-c2db-4b01-86c7-3fc0331918a1","html_url":"https://github.com/AtelierArith/DocstringTranslation.jl","commit_stats":null,"previous_names":["atelierarith/docstringtranslation.jl"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/AtelierArith/DocstringTranslation.jl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtelierArith%2FDocstringTranslation.jl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtelierArith%2FDocstringTranslation.jl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtelierArith%2FDocstringTranslation.jl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtelierArith%2FDocstringTranslation.jl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AtelierArith","download_url":"https://codeload.github.com/AtelierArith/DocstringTranslation.jl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AtelierArith%2FDocstringTranslation.jl/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261786939,"owners_count":23209574,"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":["julia","julialang","openai","openai-ap","translator"],"created_at":"2024-12-13T02:10:36.371Z","updated_at":"2025-06-25T01:42:47.549Z","avatar_url":"https://github.com/AtelierArith.png","language":"Julia","funding_links":["https://github.com/sponsors/terasakisatoshi"],"categories":[],"sub_categories":[],"readme":"# DocstringTranslation.jl\n\n[![Build Status](https://github.com/AtelierArith/DocstringTranslation.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/AtelierArith/DocstringTranslation.jl/actions/workflows/CI.yml?query=branch%3Amain) [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://AtelierArith.github.io/DocstringTranslation.jl/stable/) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://AtelierArith.github.io/DocstringTranslation.jl/dev/) [![Aqua QA](https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg)](https://github.com/JuliaTesting/Aqua.jl) [![DeepWiki](https://img.shields.io/badge/DeepWiki-AtelierArith%2FDocstringTranslation.jl-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/AtelierArith/DocstringTranslation.jl)\n\u003c!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ --\u003e\n\n## Description\n\nThis Julia package inserts Large Language Model (LLM) hooks into the API in the Base.Docs module, giving non-English speaking users the opportunity to help smooth API comprehension.\n\n## Prerequisite\n\n### Install Julia\n\nInstall Julia using juliaup.\n\n```sh\n$ curl -fsSL https://install.julialang.org | sh -s -- --yes\n```\n\n### Get OpenAI API Key\n\nCurrently, this package utilizes [OpenAI.jl](https://github.com/JuliaML/OpenAI.jl), a OpenAPI wrapper for Julia. Please prepare API key. See the following resources to learn more\n\n- [OpenAI.jl's instruction](https://github.com/JuliaML/OpenAI.jl) to learn more.\n- [Developer quickstart\n](https://platform.openai.com/docs/quickstart)\n- [Where do I find my OpenAI API Key?](https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key)\n\n### Set `OPENAI_API_KEY` environment variable\n\nTo use the OpenAI API, you'll need to set your API key as an environment variable named `OPENAI_API_KEY`.\nCreate a file named `.env` the current working directory. Add the following line to the `.env` file, replacing \u003cyour_api_key\u003e with your actual API key:\n\n```\nOPENAI_API_KEY=sk-\u003cyour_api_key\u003e\n```\n\nUse the [DotEnv.jl](https://github.com/tecosaur/DotEnv.jl) package to load the environment variables from the `.env` file:\n\n```julia\nusing Pkg; Pkg.add(\"DotEnv\")\nusing DotEnv\n\nDotEnv.load!()\n```\n\nTo ensure the API key is set correctly, use the following Julia code:\n\n```julia\n@assert haskey(ENV, \"OPENAI_API_KEY\")\n```\n\nThis assertion will throw an error if the `OPENAI_API_KEY` environment variable is not defined.\n\n## Usage\n\n```sh\n$ cd path/to/directory\n$ julia\n               _\n   _       _ _(_)_     |  Documentation: https://docs.julialang.org\n  (_)     | (_) (_)    |\n   _ _   _| |_  __ _   |  Type \"?\" for help, \"]?\" for Pkg help.\n  | | | | | | |/ _` |  |\n  | | |_| | | | (_| |  |  Version 1.11.1 (2024-10-16)\n _/ |\\__'_|_|_|\\__'_|  |  Official https://julialang.org/ release\n|__/                   |\n\njulia\u003e using Pkg; Pkg.activate(\".\"); Pkg.instantiate()\n\njulia\u003e using DocstringTranslation\n\njulia\u003e using DotEnv\n\njulia\u003e DotEnv.load!()\n\njulia\u003e @switchlang! :Japanese\n\njulia\u003e @doc pi\n  π\n  pi\n\n  定数pi。\n\n  Unicode πはJulia\n  REPLで\\piと入力してからタブキーを押すことで入力できます。また、多くのエディタでも同様です。\n\n  参照: sinpi、sincospi、deg2rad。\n\n  例\n  ≡≡\n\n  julia\u003e pi\n  π = 3.1415926535897...\n\n  julia\u003e 1/2pi\n  0.15915494309189535\n\njulia\u003e @switchlang! :German\n\njulia\u003e # You can also ask from help mode\n\nhelp?\u003e ℯ\njulia\u003e @doc ℯ\n  ℯ\n  e\n\n  Die Konstante ℯ.\n\n  Unicode ℯ kann eingegeben werden, indem man \\euler schreibt und die\n  Tabulatortaste im Julia REPL und in vielen Editoren drückt.\n\n  Siehe auch: exp, cis, cispi.\n\n  Beispiele\n  ≡≡≡≡≡≡≡≡≡\n\n  julia\u003e ℯ\n  ℯ = 2.7182818284590...\n\n  julia\u003e log(ℯ)\n  1\n\n  julia\u003e ℯ^(im)π ≈ -1\n  true\n\njulia\u003e\n```\n\n## Appendix\n\nIf you are using 1PassWord, `op` command is good for you. Store the following content instead of writing API key directly:\n\n```\n# .env\nOPENAI_API_KEY=op://Personal/OpenAI API Key/api key\n```\n\nTo launch `julia` run the following command:\n\n```sh\n$ op run --env-file=./.env -- julia\n```\n\nIn this case, you don't have to load DotEnv package:\n\n```julia\n               _\n   _       _ _(_)_     |  Documentation: https://docs.julialang.org\n  (_)     | (_) (_)    |\n   _ _   _| |_  __ _   |  Type \"?\" for help, \"]?\" for Pkg help.\n  | | | | | | |/ _` |  |\n  | | |_| | | | (_| |  |  Version 1.11.5 (2025-04-14)\n _/ |\\__'_|_|_|\\__'_|  |  Official https://julialang.org/ release\n|__/                   |\n\njulia\u003e using DocstringTranslation; @switchlang! :Japanese; @doc exp\n\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatelierarith%2Fdocstringtranslation.jl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatelierarith%2Fdocstringtranslation.jl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatelierarith%2Fdocstringtranslation.jl/lists"}