diff --git a/locales/ja/LC_MESSAGES/CONTRIBUTING.po b/locales/ja/LC_MESSAGES/CONTRIBUTING.po index 7fac24183..04835692b 100644 --- a/locales/ja/LC_MESSAGES/CONTRIBUTING.po +++ b/locales/ja/LC_MESSAGES/CONTRIBUTING.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,7 +18,7 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" #: ../../CONTRIBUTING.md:4 msgid "Contributing to the Python Packaging Guide" @@ -42,9 +42,8 @@ msgid "" "[please open an issue here](https://github.com/pyOpenSci/python-package-" "guide/issues)." msgstr "" -"ガイドに含めるべきもののアイデアがあれば、 " -"[ここにissueを開いてください](https://github.com/pyOpenSci/python-package-guide/issues)" -" 。" +"ガイドに含めるべきもののアイデアがあれば、 [ここにissueを開いてください](https://github.com/pyOpenSci" +"/python-package-guide/issues) 。" #: ../../CONTRIBUTING.md:13 msgid "" @@ -53,9 +52,9 @@ msgid "" "modify the text directly. Or, if you are less comfortable with pull " "requests, feel free to open an issue." msgstr "" -"もしタイプミスを見つけたら、遠慮なく [submit a pull " -"request](https://github.com/pyOpenSci/python-package-guide/pulls) " -"して直接テキストを修正してください。 あるいは、プルリクエストに抵抗がある場合は、遠慮なくissueを開いてください。" +"もしタイプミスを見つけたら、遠慮なく [submit a pull request](https://github.com/pyOpenSci" +"/python-package-guide/pulls) して直接テキストを修正してください。 " +"あるいは、プルリクエストに抵抗がある場合は、遠慮なくissueを開いてください。" #: ../../CONTRIBUTING.md:14 msgid "" @@ -122,8 +121,9 @@ msgid "" "fixing typos, or if this is your first contribution to open source and " "the first approach feels too intimidating." msgstr "" -"二つ目の方法は、GitHub のウェブサイトで直接貢献する方法です。 この方法ではコンピュータのセットアップは不要で、PRを投稿した時点であなたの貢献は" -" (継続的インテグレーション) テストされますが、問題が発生した場合にフィードバックを得るまでに時間がかかります。 " +"二つ目の方法は、GitHub のウェブサイトで直接貢献する方法です。 " +"この方法ではコンピュータのセットアップは不要で、PRを投稿した時点であなたの貢献は (継続的インテグレーション) " +"テストされますが、問題が発生した場合にフィードバックを得るまでに時間がかかります。 " "誤字脱字の修正のような小さな貢献をする場合や、オープンソースへの貢献が初めてで、最初のアプローチが敷居が高いと感じる場合に最適な方法です。" #: ../../CONTRIBUTING.md:33 @@ -131,35 +131,41 @@ msgid "Forking the repository" msgstr "リポジトリをフォークする" #: ../../CONTRIBUTING.md:35 +#, fuzzy msgid "" "Independently of the approach you choose, the first step is to fork the " -"Python Packaging Guide repository into your personal GitHub space. To " -"\"fork\" a repository in GitHub means to create a copy of the main " -"repository, or repo, that you have complete control over and can modify " -"as you see fit." +"Python Packaging Guide repository into your personal GitHub space. You " +"can do this by clicking the \"Fork\" button in the top right corner of " +"the repository page." msgstr "" "どの方法を選ぶかは別として、最初のステップは Python Packaging Guide のリポジトリを個人の GitHub " "スペースにフォークすることです。 GitHubでリポジトリを \"フォーク\" " "するということは、あなたが完全にコントロールし、あなたが望むように変更することができるメインリポジトリのコピーを作成することです。" -#: ../../CONTRIBUTING.md:37 +#: ../../CONTRIBUTING.md:38 +msgid "" +"[Learn more: Fork and Clone GitHub " +"Repos](https://datascienceskills.org/lessons/git-github/git-intro/3-fork-" +"clone/) is a good resource to learn more about forking." +msgstr "" + +#: ../../CONTRIBUTING.md:40 msgid "To fork a repo," msgstr "レポジトリをフォークする、" -#: ../../CONTRIBUTING.md:39 +#: ../../CONTRIBUTING.md:42 msgid "Make sure you are logged into GitHub." msgstr "GitHubにログインしていることを確認してください。" -#: ../../CONTRIBUTING.md:41 +#: ../../CONTRIBUTING.md:44 msgid "" "Go to the repo you would like to fork, in this case the [Python Packaging" " Guide](https://www.github.com/pyopensci/python-package-guide) repo." msgstr "" -"フォークしたいリポジトリ、ここでは " -"[Pythonパッケージングガイド](https://www.github.com/pyopensci/python-package-guide) " -"リポジトリに移動します。" +"フォークしたいリポジトリ、ここでは [Pythonパッケージングガイド](https://www.github.com/pyopensci" +"/python-package-guide) リポジトリに移動します。" -#: ../../CONTRIBUTING.md:43 +#: ../../CONTRIBUTING.md:46 msgid "" "In the top right-hand corner of the page there is a 'Fork' button. Click " "that button. You will be brought to a new page where you will 'Create a " @@ -168,161 +174,428 @@ msgid "" "`https://github.com//python-package-guide`, where `` " "is your GitHub username." msgstr "" -"ページの右上に 'Fork' ボタンがあります。そのボタンをクリックしてください。 新しいページが表示され、そこで '新しいフォークを作成' します。 " -"デフォルトの入力のまま、'Create fork' をクリックします。 これで、 " +"ページの右上に 'Fork' ボタンがあります。そのボタンをクリックしてください。 新しいページが表示され、そこで '新しいフォークを作成' " +"します。 デフォルトの入力のまま、'Create fork' をクリックします。 これで、 " "`https://github.com/1/python-package-guide` にリポジトリのコピーが作成されます。 " "`` はあなたの GitHub ユーザー名です。" -#: ../../CONTRIBUTING.md:47 +#: ../../CONTRIBUTING.md:51 msgid "Contributing via the GitHub website" msgstr "GitHubウェブサイトを通じて貢献する" -#: ../../CONTRIBUTING.md:49 +#: ../../CONTRIBUTING.md:53 msgid "How to edit a MarkDown file" msgstr "MarkDownファイルの編集方法" -#: ../../CONTRIBUTING.md:51 +#: ../../CONTRIBUTING.md:55 msgid "" -"*__TODO__: This section should show how to use the GitHub interface to " -"edit and previewing a Markdown file.*" +"The Python Packaging Guide is written in myST, a variant of MarkDown. You" +" can edit the files directly in the GitHub website. To do so, navigate to" +" the file you want to edit and click the pencil icon in the top right " +"corner of the file." msgstr "" -"*__TODO__: このセクションでは、GitHub のインターフェイスを使って Markdown " -"ファイルを編集したりプレビューしたりする方法を説明します。*" -#: ../../CONTRIBUTING.md:53 +#: ../../CONTRIBUTING.md:58 +msgid "Edit button in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:64 +msgid "" +"An image showing how to edit a file in GitHub. The pencil icon is " +"highlighted with a red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:66 +msgid "Edit file in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:72 +msgid "" +"An image showing when a file is being edited in GitHub. The file content " +"is displayed in a text editor." +msgstr "" + +#: ../../CONTRIBUTING.md:75 +msgid "To preview your changes, click the \"Preview changes\" tab." +msgstr "" + +#: ../../CONTRIBUTING.md:77 +msgid "Preview changes in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:83 +msgid "" +"An image showing how to preview changes in GitHub. The file content is " +"displayed in a text editor. The preview changes tab is highlighted with a" +" red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:86 msgid "How to commit your changes" msgstr "変更をコミットする方法" -#: ../../CONTRIBUTING.md:55 +#: ../../CONTRIBUTING.md:88 msgid "" -"*__TODO__: This section should show how to commit changes via the GitHub " -"interface.*" -msgstr "*__TODO__: このセクションでは、GitHub インターフェイスを使って変更をコミットする方法を説明します。*" +"When you are done editing the file, scroll down to the bottom of the " +"page. You will see a section called \"Commit changes\". Here you can " +"write a title and a description for your changes. Make sure to write a " +"clear and concise title that describes the changes you made." +msgstr "" + +#: ../../CONTRIBUTING.md:91 +#, fuzzy +msgid "Commit changes in GitHub" +msgstr "変更をコミットする" -#: ../../CONTRIBUTING.md:57 +#: ../../CONTRIBUTING.md:97 +msgid "" +"An image showing how to commit changes in GitHub. The commit message is " +"displayed in a text editor. The commit changes section is highlighted " +"with a red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:100 +msgid "" +"After writing your commit message, click the \"Commit changes\" button to" +" save your changes." +msgstr "" + +#: ../../CONTRIBUTING.md:102 msgid "Contributing locally on your computer" msgstr "あなたのコンピュータでローカルに貢献する" -#: ../../CONTRIBUTING.md:59 +#: ../../CONTRIBUTING.md:104 msgid "Clone your forked repository" msgstr "フォークしたリポジトリをクローンする" -#: ../../CONTRIBUTING.md:61 +#: ../../CONTRIBUTING.md:106 msgid "" -"*__TODO__: This section should show how to clone a repository from GitHub" -" into your computer.*" -msgstr "*__TODO__: このセクションでは、GitHub から自分のコンピューターにリポジトリをクローンする方法を説明します。*" +"To clone your forked repository to your computer, you need to copy the " +"URL of your forked repository and run the following command in your " +"terminal:" +msgstr "" -#: ../../CONTRIBUTING.md:63 +#: ../../CONTRIBUTING.md:111 +msgid "" +"Replace `` with the URL of your forked repository. You can find the " +"URL by clicking the green \"Code\" button on your forked repository page." +msgstr "" + +#: ../../CONTRIBUTING.md:113 +msgid "Clone repository in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:119 +msgid "" +"An image showing how to clone a repository in GitHub. The URL of the " +"repository is displayed in a text editor. The code button is highlighted " +"with a red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:122 msgid "Create a new branch" msgstr "新しいブランチを作る" -#: ../../CONTRIBUTING.md:65 -msgid "*__TODO__: This section should show how to create a new branch.*" -msgstr "*__TODO__: このセクションでは、新しいブランチを作成する方法を説明します。*" +#: ../../CONTRIBUTING.md:124 +msgid "" +"Before making any changes, you should create a new branch to work on. " +"This will help keep your changes separate from the main branch and make " +"it easier to submit a pull request." +msgstr "" -#: ../../CONTRIBUTING.md:67 +#: ../../CONTRIBUTING.md:126 +msgid "To create a new branch, run the following command in your terminal:" +msgstr "" + +#: ../../CONTRIBUTING.md:132 msgid "Create a virtual environment" msgstr "仮想環境を作る" -#: ../../CONTRIBUTING.md:69 +#: ../../CONTRIBUTING.md:134 msgid "" -"*__TODO__: This section should show how to create a virtual environment " -"using venv.*" -msgstr "*__TODO__: このセクションでは、venvを使用して仮想環境を作成する方法について説明する。*" +"To build the guide locally, you need to create a virtual environment and " +"install the dependencies. You can do this by running the following " +"commands in your terminal:" +msgstr "" + +#: ../../CONTRIBUTING.md:136 +msgid "**On Windows**:" +msgstr "" -#: ../../CONTRIBUTING.md:71 +#: ../../CONTRIBUTING.md:142 +msgid "**On MacOS and Linux**:" +msgstr "" + +#: ../../CONTRIBUTING.md:148 msgid "Install the development dependencies" msgstr "開発依存パッケージをインストールする" -#: ../../CONTRIBUTING.md:73 +#: ../../CONTRIBUTING.md:150 +#, fuzzy msgid "" -"*__TODO__: This section should show how to install the development " -"dependencies defined in pyproject.toml.*" -msgstr "*__TODO__: このセクションでは、pyproject.tomlで定義されている開発依存関係をインストールする方法を示します。*" +"To install the development dependencies, run the following command in " +"your terminal:" +msgstr "開発依存パッケージをインストールする" -#: ../../CONTRIBUTING.md:75 +#: ../../CONTRIBUTING.md:156 msgid "Commit your changes" msgstr "変更をコミットする" -#: ../../CONTRIBUTING.md:77 +#: ../../CONTRIBUTING.md:158 +msgid "" +"After making your changes, you need to commit them to your local " +"repository. To do this, run the following commands in your terminal:" +msgstr "" + +#: ../../CONTRIBUTING.md:160 +msgid "To see the changes you made:" +msgstr "" + +#: ../../CONTRIBUTING.md:164 +msgid "To add the changes to the staging area:" +msgstr "" + +#: ../../CONTRIBUTING.md:168 +#, fuzzy +msgid "To commit the changes:" +msgstr "変更をコミットする方法" + +#: ../../CONTRIBUTING.md:172 msgid "" -"*__TODO__: This section should describe how to commit from the command " -"line.*" -msgstr "*__TODO__: このセクションでは、コマンドラインからコミットする方法を説明します。*" +"Replace `\"Your commit message here\"` with a clear and concise message " +"that describes the changes you made." +msgstr "" -#: ../../CONTRIBUTING.md:79 +#: ../../CONTRIBUTING.md:174 msgid "How to build the guide locally" msgstr "ローカルでのガイドのビルド方法" -#: ../../CONTRIBUTING.md:81 +#: ../../CONTRIBUTING.md:176 msgid "" -"*__TODO__: This section should describe the different sessions in nox " -"related to building the docs: docs, docs-test, docs-live. It should also " -"show how to see the guide built locally, by opening the right file in the" -" browser or using the live version from docs-live*" +"To build the guide locally, you can use the `nox` command. This will run " +"the default `nox` session, which builds the guide and opens it in your " +"browser." msgstr "" -"*TODO__: docs、docs-test、docs-liveです。また、ブラウザで適切なファイルを開くか、docs-" -"liveからライブバージョンを使用することで、ローカルで構築されたガイドを見る方法を示す必要があります。*" -#: ../../CONTRIBUTING.md:83 +#: ../../CONTRIBUTING.md:178 +msgid "" +"To see the different sessions available, you can run the following " +"command in your terminal:" +msgstr "" + +#: ../../CONTRIBUTING.md:183 +msgid "" +"There are different sessions in nox related to building the docs: `docs`," +" `docs-test`, `docs-live`. You can run them by specifying the session " +"name after the `nox` command." +msgstr "" + +#: ../../CONTRIBUTING.md:185 +msgid "`docs`: this session builds the guide and opens it in your browser." +msgstr "" + +#: ../../CONTRIBUTING.md:189 +msgid "" +"To see the guide built locally, open the file `_build/html/index.html` in" +" your browser." +msgstr "" + +#: ../../CONTRIBUTING.md:191 +msgid "`docs-test`: this session runs the tests for the guide." +msgstr "" + +#: ../../CONTRIBUTING.md:195 +msgid "" +"If the tests fail, you will see an error message in your terminal. You " +"need to fix the errors before submitting your pull request." +msgstr "" + +#: ../../CONTRIBUTING.md:197 +msgid "" +"`docs-live`: this session builds the guide and opens it in your browser " +"with live reloading." +msgstr "" + +#: ../../CONTRIBUTING.md:201 +msgid "" +"open the local version of the guide in your browser at ``localhost`` " +"shown in the terminal." +msgstr "" + +#: ../../CONTRIBUTING.md:203 msgid "Before you submit your pull request" msgstr "プルリクエストを提出する前に" -#: ../../CONTRIBUTING.md:85 +#: ../../CONTRIBUTING.md:205 msgid "" -"*__TODO__: This section should describe what steps a user should follow " -"before submitting the pull request: build the docs, verify your changes " -"look correct, etc.*" +"Before submitting your pull request, make sure to run the tests and check" +" the formatting of your code." msgstr "" -"*__TODO__: " -"このセクションでは、ユーザーがプルリクエストを提出する前にどのようなステップを踏むべきかを記述する必要があります:ドキュメントをビルドする、変更が正しく見えるか確認する、などです。*" -#: ../../CONTRIBUTING.md:87 +#: ../../CONTRIBUTING.md:210 +msgid "" +"If the tests fail, you will see an error message in your terminal. You " +"need to fix the errors before submitting your pull request. Also make " +"sure to check the formatting of your documentation by building the docs " +"locally and checking that your changes look correct." +msgstr "" + +#: ../../CONTRIBUTING.md:214 msgid "Submitting a pull request with your contribution" msgstr "あなたの貢献のプルリクエストを投稿する" -#: ../../CONTRIBUTING.md:89 +#: ../../CONTRIBUTING.md:216 msgid "How to make a pull request" msgstr "プルリクエストの作り方" -#: ../../CONTRIBUTING.md:91 +#: ../../CONTRIBUTING.md:218 +msgid "" +"To open a pull request on GitHub, navigate to the main page of your " +"forked repository and click on the \"Pull requests\" tab." +msgstr "" + +#: ../../CONTRIBUTING.md:220 +msgid "Pull requests tab in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:226 +msgid "" +"An image showing how to navigate to the pull requests tab in GitHub. The " +"pull requests tab is highlighted with a red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:229 +msgid "Click on the \"New pull request\" button." +msgstr "" + +#: ../../CONTRIBUTING.md:231 +msgid "New pull request button in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:237 msgid "" -"*__TODO__: This section should describe how to make a pull request in " -"GitHub.*" -msgstr "*__TODO__: このセクションでは、GitHub でプルリクエストを行う方法について説明します。*" +"An image showing how to create a new pull request in GitHub. The new pull" +" request button is highlighted with a red rectangle." +msgstr "" -#: ../../CONTRIBUTING.md:93 +#: ../../CONTRIBUTING.md:240 +msgid "" +"Write a clear and concise title and description for your pull request. " +"Make sure to describe the changes you made and why they are necessary." +msgstr "" + +#: ../../CONTRIBUTING.md:242 msgid "What happens when you submit a pull request (CI/CD)" msgstr "プルリクエストを提出するとどうなるか(CI/CD)" -#: ../../CONTRIBUTING.md:95 +#: ../../CONTRIBUTING.md:244 msgid "" -"*__TODO__: This section should describe how to see the results of the " -"CD/CI checks and how to get more information about errors*" -msgstr "*__TODO__: このセクションでは、CD/CIチェックの結果を確認する方法と、エラーに関する詳細情報を得る方法について説明します。*" +"Once you submit a pull request, a series of checks will be run to ensure " +"that your changes do not introduce any bugs or errors. These checks " +"include:" +msgstr "" -#: ../../CONTRIBUTING.md:97 +#: ../../CONTRIBUTING.md:246 +msgid "" +"**Code formatting and styles**: checks that your code is formatted " +"correctly, by `pre-commit.ci - pr check`." +msgstr "" + +#: ../../CONTRIBUTING.md:247 +msgid "" +"**docs build**: checks that the documentation builds correctly, using " +"`circleci`." +msgstr "" + +#: ../../CONTRIBUTING.md:249 +msgid "You will see the status of these checks in your pull request." +msgstr "" + +#: ../../CONTRIBUTING.md:251 +msgid "Pull request checks in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:257 +msgid "" +"An image showing the status of the checks in a pull request in GitHub. " +"The checks are displayed in a table with a status icon next to each " +"check. The checks are highlighted with a red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:259 +msgid "" +"If any of these checks fail, you will see an error message in your pull " +"request. You need to fix the errors before your changes can be merged." +msgstr "" + +#: ../../CONTRIBUTING.md:261 +msgid "Pull request checks failed in GitHub" +msgstr "" + +#: ../../CONTRIBUTING.md:267 +msgid "" +"An image showing the status of the checks in a pull request in GitHub. " +"The checks are displayed in a table with a status icon next to each " +"check. The checks that failed and the details link are highlighted with a" +" red rectangle." +msgstr "" + +#: ../../CONTRIBUTING.md:270 +msgid "" +"To get more information about the errors, you can click on the " +"\"Details\" link next to the failed check." +msgstr "" + +#: ../../CONTRIBUTING.md:272 msgid "What to expect from the review process" msgstr "レビュープロセスに期待すること" -#: ../../CONTRIBUTING.md:99 +#: ../../CONTRIBUTING.md:274 +msgid "" +"Once you submit a pull request, a maintainer of the repository will " +"review your changes and provide feedback. The review process may involve:" +msgstr "" + +#: ../../CONTRIBUTING.md:276 +msgid "" +"**Comments**: the reviewer may leave comments on your pull request to ask" +" questions or provide feedback." +msgstr "" + +#: ../../CONTRIBUTING.md:277 msgid "" -"*__TODO__: This section should describe how review happens in GitHub, how" -" see the comments, and how to submit changes (push a new branch)*" +"**Suggestions**: the reviewer may suggest changes to your code or " +"documentation." msgstr "" -"*__TODO__: このセクションでは、GitHub でどのようにレビューが行われるのか、どのようにコメントを見るのか、どのように変更を投稿するのか " -"(新しいブランチをプッシュするのか) について説明します。*" -#: ../../CONTRIBUTING.md:101 +#: ../../CONTRIBUTING.md:278 +msgid "" +"**Approvals**: once the reviewer is satisfied with your changes, they " +"will approve the pull request." +msgstr "" + +#: ../../CONTRIBUTING.md:280 +msgid "" +"You can make changes to your pull request by pushing new commits to the " +"branch. The pull request will be updated automatically with your new " +"changes." +msgstr "" + +#: ../../CONTRIBUTING.md:282 +msgid "" +"Once your pull request is approved, it will be merged into the main " +"branch and your changes will be included in the guide." +msgstr "" + +#: ../../CONTRIBUTING.md:284 msgid "Additional help" msgstr "追加ヘルプ" -#: ../../CONTRIBUTING.md:103 +#: ../../CONTRIBUTING.md:286 msgid "How to get help" msgstr "助けを求めるには" -#: ../../CONTRIBUTING.md:105 +#: ../../CONTRIBUTING.md:288 msgid "" "*__TODO__: This section should describe the options for finding more help" " in case beginner contributors need more help (e.g., create an issue, " @@ -331,25 +604,25 @@ msgstr "" "*__TODO__: このセクションには、初心者の投稿者がさらに助けを必要とする場合に備えて、より多くの助けを見つけるためのオプション " "(イシューの作成、フォーラムへの投稿など) を記述してください。*" -#: ../../CONTRIBUTING.md:107 +#: ../../CONTRIBUTING.md:290 msgid "Additional resources" msgstr "その他のリソース" -#: ../../CONTRIBUTING.md:109 +#: ../../CONTRIBUTING.md:292 msgid "" "*__TODO__: It should also include links to beginner documentation, like " "the GitHub docs.*" msgstr "*__TODO__: また、GitHubのドキュメントのような初心者向けのドキュメントへのリンクも含める必要があります。*" -#: ../../CONTRIBUTING.md:111 +#: ../../CONTRIBUTING.md:294 msgid "Annex" msgstr "付録" -#: ../../CONTRIBUTING.md:113 +#: ../../CONTRIBUTING.md:296 msgid "Code examples" msgstr "コード例" -#: ../../CONTRIBUTING.md:115 +#: ../../CONTRIBUTING.md:298 msgid "" "This guide uses the [literalinclude Sphinx directive](https://www.sphinx-" "doc.org/en/master/usage/restructuredtext/directives.html#directive-" @@ -358,21 +631,23 @@ msgid "" msgstr "" "このガイドでは、可能な限り [iteralinclude Sphinx ディレクティブ](https://www.sphinx-" "doc.org/en/master/usage/restructuredtext/directives.html#directive-" -"literalinclude) を使用して、コードと散文を分けています。 ドキュメントで使用するコードは `examples/` フォルダにあります。" +"literalinclude) を使用して、コードと散文を分けています。 ドキュメントで使用するコードは `examples/` " +"フォルダにあります。" -#: ../../CONTRIBUTING.md:119 +#: ../../CONTRIBUTING.md:302 msgid "Referencing code in documentation" msgstr "ドキュメントでコードを参照する" -#: ../../CONTRIBUTING.md:121 +#: ../../CONTRIBUTING.md:304 msgid "" "If an example is present elsewhere in the documentation that you want to " "use, you can copy the `literalinclude` directive verbatim and the " "examples will stay in sync." msgstr "" -"使用したい例がドキュメントの他の場所にある場合、 `literalinclude` ディレクティブをそのままコピーすれば、例は同期されたままになります。" +"使用したい例がドキュメントの他の場所にある場合、 `literalinclude` " +"ディレクティブをそのままコピーすれば、例は同期されたままになります。" -#: ../../CONTRIBUTING.md:124 +#: ../../CONTRIBUTING.md:307 msgid "" "If you already see code in the examples folder that you can use for new " "documentation, a new `literalinclude` can be made to extract it into the " @@ -382,11 +657,11 @@ msgid "" "the later can protect your example from future modifications to the code." msgstr "" "すでに example フォルダに新しいドキュメントに使えそうなコードがある場合は、新しい `literalinclude` " -"を作成して、それをサイトに展開することができます。 動作する `literalinclude` に必要なのはコードへの相対パスだけですが、ほとんどの場合" -" `:language:` と `:lines:` も指定する必要があります。 " +"を作成して、それをサイトに展開することができます。 動作する `literalinclude` " +"に必要なのはコードへの相対パスだけですが、ほとんどの場合 `:language:` と `:lines:` も指定する必要があります。 " "前者はコード例をより美しくし、後者は将来的なコードの変更からサンプルを守ることができます。" -#: ../../CONTRIBUTING.md:129 +#: ../../CONTRIBUTING.md:312 msgid "" "**Pro tip**: As an alternative to `:lines:` there are also the `:start-" "after:`, `:start-at:`, `:end-before:`, and `:end-at:` options. And if the" @@ -397,19 +672,20 @@ msgstr "" "before:`, `:end-at:` オプションもあります。 また、サンプルコードがPythonの場合、 `:pyobject:` " "を使用すると、コードのリファクタリングがあっても同じドキュメント内容を維持することができます。" -#: ../../CONTRIBUTING.md:133 +#: ../../CONTRIBUTING.md:316 +#, fuzzy msgid "" "If you need example code that doesn't yet exist in `examples/` see " -"creating code for documentation](#creating-code-for-documentation)." +"[creating code for documentation](#creating-code-for-documentation)." msgstr "" "`examples/` にまだ存在しないサンプルコードが必要な場合は、 ドキュメント用のコードを作成する](#creating-code-for-" "documentation) を参照してください。" -#: ../../CONTRIBUTING.md:136 +#: ../../CONTRIBUTING.md:319 msgid "Creating code for documentation" msgstr "ドキュメント用コードの作成" -#: ../../CONTRIBUTING.md:138 +#: ../../CONTRIBUTING.md:321 msgid "" "Whenever you come across a place that could benefit from a code block, " "instead of writing it in-line with a code fence (`` ``` `` blocked text) " @@ -418,10 +694,10 @@ msgid "" "code-in-documentation)." msgstr "" "コードブロックが役立つ場所に出くわしたら、コードフェンス (`` ``` `` " -"ブロックテキスト)と一緒にインラインで書く代わりに、独自の形式でファイルとして書くことができます。 あなたの例はすでに存在しているかもしれません; " -"[ドキュメントのコードを参照する](#referencing-code-in-documentation) を参照してください。" +"ブロックテキスト)と一緒にインラインで書く代わりに、独自の形式でファイルとして書くことができます。 あなたの例はすでに存在しているかもしれません;" +" [ドキュメントのコードを参照する](#referencing-code-in-documentation) を参照してください。" -#: ../../CONTRIBUTING.md:142 +#: ../../CONTRIBUTING.md:325 msgid "" "If you want to add a new example that doesn't fit into any of the " "existing example files, you can create a new file and reference it in a " @@ -431,10 +707,10 @@ msgid "" msgstr "" "既存のサンプルファイルのどれにも当てはまらない新しいサンプルを追加したい場合は、新しいファイルを作成して `literalinclude` " "ブロックで参照することができます。 " -"もしそのファイルが既存のサンプルプロジェクトの中にあるのが理にかなっているのであれば、そこに追加してください。そうでなければ、 `examples` " -"ディレクトリに新しいフォルダを作成してください。" +"もしそのファイルが既存のサンプルプロジェクトの中にあるのが理にかなっているのであれば、そこに追加してください。そうでなければ、 " +"`examples` ディレクトリに新しいフォルダを作成してください。" -#: ../../CONTRIBUTING.md:146 +#: ../../CONTRIBUTING.md:329 msgid "" "If an existing example is incomplete or a new example makes sense to be " "added to an existing file, go ahead and add it, but take care to not " @@ -446,15 +722,14 @@ msgstr "" "可能な限り、例を書き直すのではなく、拡張してください。 " "例えば、ファイルの最後に新しい関数を追加したり、クラス内の既存のメソッドの後に新しいメソッドを追加したりします。" -#: ../../CONTRIBUTING.md:150 +#: ../../CONTRIBUTING.md:333 msgid "" "Example code is checked for correctness, so adding a new example may " "require adding additional tests for coverage, and will require fixing any" " failing tests." -msgstr "" -"例題のコードは正しさをチェックされるので、新しい例題を追加するには、カバレッジのためのテストを追加する必要があるかもしれないし、失敗したテストを修正する必要があるかもしれません。" +msgstr "例題のコードは正しさをチェックされるので、新しい例題を追加するには、カバレッジのためのテストを追加する必要があるかもしれないし、失敗したテストを修正する必要があるかもしれません。" -#: ../../CONTRIBUTING.md:153 +#: ../../CONTRIBUTING.md:336 msgid "" "***⚠️ WARNING***: great care should be taken when modifying existing " "example code, especially any modification beyond appending to the end of " @@ -469,19 +744,19 @@ msgstr "" "これにより、ガイド内のサンプルはより一貫したものになりますが、ある特定のユースケースのためにサンプルを修正する場合、アクションが遠のく可能性があります。" " もし既存のサンプルを修正することに気づいたら、このコマンドを実行し、新しいビルドでそれらのページをチェックしてみてください。" -#: ../../CONTRIBUTING.md:161 +#: ../../CONTRIBUTING.md:344 msgid "Example:" msgstr "例:" -#: ../../CONTRIBUTING.md:163 +#: ../../CONTRIBUTING.md:346 msgid "Instead of writing example code in markdown like this" msgstr "このようにマークダウンでサンプルコードを書くのではなく" -#: ../../CONTRIBUTING.md:174 +#: ../../CONTRIBUTING.md:357 msgid "The python can be extracted into a `.py` file" msgstr "python は `.py` ファイルに展開することができます。" -#: ../../CONTRIBUTING.md:188 +#: ../../CONTRIBUTING.md:371 msgid "" "As another example, if you only need to show part of a `pyproject.toml`, " "we already have complete project definitions, you need only to find the " @@ -490,10 +765,98 @@ msgstr "" "別の例として、 `pyproject.toml` " "の一部だけを表示する必要がある場合、我々はすでに完全なプロジェクト定義を持っているので、関連する部分を見つけるだけでよいです。" -#: ../../CONTRIBUTING.md:191 +#: ../../CONTRIBUTING.md:374 msgid "Instead of writing this" msgstr "こう書く代わりに" -#: ../../CONTRIBUTING.md:203 +#: ../../CONTRIBUTING.md:386 msgid "an example could be extracted from an existing toml file" msgstr "例は、既存のtomlファイルから抽出することができます" + +#~ msgid "" +#~ "*__TODO__: This section should show how" +#~ " to use the GitHub interface to " +#~ "edit and previewing a Markdown file.*" +#~ msgstr "" +#~ "*__TODO__: このセクションでは、GitHub のインターフェイスを使って Markdown" +#~ " ファイルを編集したりプレビューしたりする方法を説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should show how" +#~ " to commit changes via the GitHub " +#~ "interface.*" +#~ msgstr "*__TODO__: このセクションでは、GitHub インターフェイスを使って変更をコミットする方法を説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should show how" +#~ " to clone a repository from GitHub" +#~ " into your computer.*" +#~ msgstr "*__TODO__: このセクションでは、GitHub から自分のコンピューターにリポジトリをクローンする方法を説明します。*" + +#~ msgid "*__TODO__: This section should show how to create a new branch.*" +#~ msgstr "*__TODO__: このセクションでは、新しいブランチを作成する方法を説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should show how" +#~ " to create a virtual environment " +#~ "using venv.*" +#~ msgstr "*__TODO__: このセクションでは、venvを使用して仮想環境を作成する方法について説明する。*" + +#~ msgid "" +#~ "*__TODO__: This section should show how" +#~ " to install the development dependencies" +#~ " defined in pyproject.toml.*" +#~ msgstr "*__TODO__: このセクションでは、pyproject.tomlで定義されている開発依存関係をインストールする方法を示します。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "how to commit from the command " +#~ "line.*" +#~ msgstr "*__TODO__: このセクションでは、コマンドラインからコミットする方法を説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "the different sessions in nox related" +#~ " to building the docs: docs, docs-" +#~ "test, docs-live. It should also " +#~ "show how to see the guide built" +#~ " locally, by opening the right file" +#~ " in the browser or using the " +#~ "live version from docs-live*" +#~ msgstr "" +#~ "*TODO__: docs、docs-test、docs-" +#~ "liveです。また、ブラウザで適切なファイルを開くか、docs-" +#~ "liveからライブバージョンを使用することで、ローカルで構築されたガイドを見る方法を示す必要があります。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "what steps a user should follow " +#~ "before submitting the pull request: " +#~ "build the docs, verify your changes " +#~ "look correct, etc.*" +#~ msgstr "" +#~ "*__TODO__: " +#~ "このセクションでは、ユーザーがプルリクエストを提出する前にどのようなステップを踏むべきかを記述する必要があります:ドキュメントをビルドする、変更が正しく見えるか確認する、などです。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "how to make a pull request in " +#~ "GitHub.*" +#~ msgstr "*__TODO__: このセクションでは、GitHub でプルリクエストを行う方法について説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "how to see the results of the " +#~ "CD/CI checks and how to get more" +#~ " information about errors*" +#~ msgstr "*__TODO__: このセクションでは、CD/CIチェックの結果を確認する方法と、エラーに関する詳細情報を得る方法について説明します。*" + +#~ msgid "" +#~ "*__TODO__: This section should describe " +#~ "how review happens in GitHub, how " +#~ "see the comments, and how to " +#~ "submit changes (push a new branch)*" +#~ msgstr "" +#~ "*__TODO__: このセクションでは、GitHub " +#~ "でどのようにレビューが行われるのか、どのようにコメントを見るのか、どのように変更を投稿するのか " +#~ "(新しいブランチをプッシュするのか) について説明します。*" diff --git a/locales/ja/LC_MESSAGES/TRANSLATING.po b/locales/ja/LC_MESSAGES/TRANSLATING.po index 0f8746896..ff1628873 100644 --- a/locales/ja/LC_MESSAGES/TRANSLATING.po +++ b/locales/ja/LC_MESSAGES/TRANSLATING.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,7 +18,7 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" #: ../../TRANSLATING.md:5 msgid "Translation Guide for the Python Packaging Guide" @@ -36,8 +36,7 @@ msgid "" " the process of contributing to the guide itself, except that instead of " "working on the guide source files directly, you will be working on the " "translation files." -msgstr "" -"ガイドの翻訳に貢献するプロセスは、ガイドのソースファイルに直接取り組むのではなく、翻訳ファイルに取り組むという点を除けば、ガイドそのものに貢献するプロセスと似ています。" +msgstr "ガイドの翻訳に貢献するプロセスは、ガイドのソースファイルに直接取り組むのではなく、翻訳ファイルに取り組むという点を除けば、ガイドそのものに貢献するプロセスと似ています。" #: ../../TRANSLATING.md:11 msgid "Overview of the Translation Process" @@ -58,8 +57,7 @@ msgid "" "Sphinx, the documentation engine we use to build the Python Package " "Guide, has built-in support for internationalization, so the workflow is " "very straightforward." -msgstr "" -"Pythonパッケージガイドをビルドするために使っているドキュメントエンジンであるSphinxは、国際化をビルトインでサポートしているので、ワークフローはとても簡単です。" +msgstr "Pythonパッケージガイドをビルドするために使っているドキュメントエンジンであるSphinxは、国際化をビルトインでサポートしているので、ワークフローはとても簡単です。" #: ../../TRANSLATING.md:17 msgid "" @@ -154,9 +152,8 @@ msgid "" "language, start by [creating an issue](https://github.com/pyOpenSci" "/python-package-guide/issues) in the repository." msgstr "" -"新しい言語へのガイドの翻訳を開始したい場合は、リポジトリに " -"[issueを作成する](https://github.com/pyOpenSci/python-package-guide/issues) " -"ことから始めてください。" +"新しい言語へのガイドの翻訳を開始したい場合は、リポジトリに [issueを作成する](https://github.com/pyOpenSci" +"/python-package-guide/issues) ことから始めてください。" #: ../../TRANSLATING.md:55 msgid "" @@ -179,9 +176,11 @@ msgstr "" "例えば、フランス語への翻訳を開始したい場合は `'fr'` を追加します:" #: ../../TRANSLATING.md:68 +#, fuzzy msgid "" -"You can find a list of the two-letter ISO language codes " -"[here](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)." +"You can find a list of the two-letter Sphinx language option " +"[here](https://www.sphinx-doc.org/en/master/usage/configuration.html" +"#confval-language)." msgstr "" "2文字のISO言語コードのリストは " "[こちら](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes)。" @@ -201,8 +200,10 @@ msgstr "" "翻訳を始める前に、翻訳ファイルがガイドの最新の変更に対応していることを確認する必要があります。" #: ../../TRANSLATING.md:75 -msgid "You can do this by running the following command:" -msgstr "次のコマンドを実行すれば可能です:" +msgid "" +"You can do this by running the following command, replacing LANG by the " +"language code you plan to work on (e.g., `es` for Spanish):" +msgstr "" #: ../../TRANSLATING.md:81 msgid "" @@ -338,8 +339,8 @@ msgid "" "there are also tools like [Poedit](https://poedit.net/) that provide a " "graphic use interface." msgstr "" -".po`ファイルの編集にはどんなテキストエディタでも使えます。 しかし、お好みであれば、 [Poedit](https://poedit.net/) " -"のようなグラフィックなインターフェースを提供するツールもあります。" +".po`ファイルの編集にはどんなテキストエディタでも使えます。 しかし、お好みであれば、 " +"[Poedit](https://poedit.net/) のようなグラフィックなインターフェースを提供するツールもあります。" #: ../../TRANSLATING.md:146 msgid "" @@ -351,8 +352,8 @@ msgid "" msgstr "" "お使いのエディタによっては、`.po`ファイルを扱うためのシンタックスハイライトやその他の機能を提供するプラグインや拡張機能をインストールできるかもしれません。" " 例えば、Visual Studio Codeの " -"[gettext](https://marketplace.visualstudio.com/items?itemName=mrorz.language-" -"gettext) エクステンションのようなものです。" +"[gettext](https://marketplace.visualstudio.com/items?itemName=mrorz" +".language-gettext) エクステンションのようなものです。" #: ../../TRANSLATING.md:148 msgid "" @@ -388,24 +389,22 @@ msgid "" "`msgstr` fields in the example below start with an empty string, " "indicating that the text continues in the next line." msgstr "" -"英語の原文が1行では長すぎて、複数行に分かれている場合があります。 このような場合、翻訳されたテキストでも同じ構造を保つことができます。 以下の例の " -"`msgid` フィールドと `msgstr` フィールドの両方が空文字列で始まっていることに注意してください。" +"英語の原文が1行では長すぎて、複数行に分かれている場合があります。 このような場合、翻訳されたテキストでも同じ構造を保つことができます。 " +"以下の例の `msgid` フィールドと `msgstr` フィールドの両方が空文字列で始まっていることに注意してください。" #: ../../TRANSLATING.md:186 msgid "" "The English text will sometimes contain Markdown formatting, such as bold" " or italic text. You should keep the formatting in the translated text, " "making sure to translate the text inside the formatting tags." -msgstr "" -"英語のテキストには、太字や斜体などのMarkdown書式が含まれていることがあります。翻訳されたテキストで書式を維持する必要があります、フォーマットタグの中のテキストを翻訳してください。" +msgstr "英語のテキストには、太字や斜体などのMarkdown書式が含まれていることがあります。翻訳されたテキストで書式を維持する必要があります、フォーマットタグの中のテキストを翻訳してください。" #: ../../TRANSLATING.md:188 msgid "" "The English text may also contain links to other sections of the guide or" " external resources. You should keep the links in the translated text, " "making sure to update the link text when appropriate." -msgstr "" -"英文テキストには、ガイドの他のセクションや外部リソースへのリンクが含まれている場合があります。リンクは翻訳されたテキストの中に残し、必要に応じてリンクテキストを更新してください。" +msgstr "英文テキストには、ガイドの他のセクションや外部リソースへのリンクが含まれている場合があります。リンクは翻訳されたテキストの中に残し、必要に応じてリンクテキストを更新してください。" #: ../../TRANSLATING.md:196 msgid "" @@ -415,8 +414,8 @@ msgid "" " in the entry, starting with `#,`:" msgstr "" "エントリーには `fuzzy` " -"と表示されることがありますが、これは原文の英文が翻訳後に変更され、翻訳を修正する必要があることを意味します。このような場合、エントリーに `#,` " -"で始まる行が追加されます:" +"と表示されることがありますが、これは原文の英文が翻訳後に変更され、翻訳を修正する必要があることを意味します。このような場合、エントリーに `#,`" +" で始まる行が追加されます:" #: ../../TRANSLATING.md:213 msgid "" @@ -430,8 +429,7 @@ msgid "" "start with a `#` character to the entry. This can be helpful to add " "context to the translation for other translators or reviewers to see, but" " this might be only necessary in special circumstances." -msgstr "" -"文字で始まる行をエントリに追加することで、翻訳ファイルにコメントを追加することもできます。これは、他の翻訳者やレビュアーが翻訳を見るために文脈を追加するのに役立ちます、しかし、これは特別な状況でのみ必要かもしれません。" +msgstr "文字で始まる行をエントリに追加することで、翻訳ファイルにコメントを追加することもできます。これは、他の翻訳者やレビュアーが翻訳を見るために文脈を追加するのに役立ちます、しかし、これは特別な状況でのみ必要かもしれません。" #: ../../TRANSLATING.md:218 msgid "" @@ -449,12 +447,13 @@ msgid "Building the Translated Documentation" msgstr "翻訳されたドキュメントのビルド" #: ../../TRANSLATING.md:223 +#, fuzzy msgid "" "Once you finished translating or when you want to check the translation " "in context, you can build the guide locally on your computer, using the " -"following command:" -msgstr "" -"翻訳が終わったら、あるいは文脈の中で翻訳をチェックしたい場合は、次のコマンドを使用して、ガイドをコンピュータにローカルにビルドすることができます:" +"following command, replacing LANG by the proper language code (e.g., `es`" +" for Spanish)" +msgstr "翻訳が終わったら、あるいは文脈の中で翻訳をチェックしたい場合は、次のコマンドを使用して、ガイドをコンピュータにローカルにビルドすることができます:" #: ../../TRANSLATING.md:229 msgid "" @@ -488,14 +487,15 @@ msgstr "" "例えば、スペイン語翻訳に取り組んでいる場合、次のように実行します:" #: ../../TRANSLATING.md:239 +#, fuzzy msgid "" "Note the `--` before the language code, it indicates that the following " "arguments should be passed into the nox session and not be interpreted " "directly by nox. If you forget the `--`, nox will look instead for a " -"session named 'es' and complain that it does not exist." +"session named 'es' and raise an error that it does not exist." msgstr "" -"言語コードの前の `--` に注意してください。これは次の引数がnoxセッションに渡され、noxによって直接解釈されないことを示します。 もし `--`" -" を忘れると、noxは代わりに 'es' という名前のセッションを探し、それが存在しないと文句を言います。" +"言語コードの前の `--` に注意してください。これは次の引数がnoxセッションに渡され、noxによって直接解釈されないことを示します。 もし " +"`--` を忘れると、noxは代わりに 'es' という名前のセッションを探し、それが存在しないと文句を言います。" #: ../../TRANSLATING.md:241 msgid "" @@ -503,8 +503,9 @@ msgid "" "where you can access the translated version of the guide. You can open " "the guide in your browser by navigating to `http://localhost:8000`." msgstr "" -"このコマンドは `sphinx-autobuild` を使って、ローカルのWebサーバーを起動し、そこでガイドの翻訳版にアクセスすることができます。 " -"ブラウザで `http://localhost:8000` に移動して、ガイドを開くことができます。" +"このコマンドは `sphinx-autobuild` " +"を使って、ローカルのWebサーバーを起動し、そこでガイドの翻訳版にアクセスすることができます。 ブラウザで " +"`http://localhost:8000` に移動して、ガイドを開くことができます。" #: ../../TRANSLATING.md:243 msgid "" @@ -522,8 +523,7 @@ msgid "" "(PR) for your translation, you need to make sure that the translated " "version of the guide builds without any errors or warning and looks " "correctly in the browser." -msgstr "" -"翻訳が終わり、翻訳のプルリクエスト（PR）を提出する前に、翻訳されたバージョンのガイドがエラーや警告なしにビルドされ、ブラウザで正しく表示されることを確認する必要があります。" +msgstr "翻訳が終わり、翻訳のプルリクエスト（PR）を提出する前に、翻訳されたバージョンのガイドがエラーや警告なしにビルドされ、ブラウザで正しく表示されることを確認する必要があります。" #: ../../TRANSLATING.md:249 msgid "You can follow these steps:" @@ -547,8 +547,8 @@ msgid "" "by opening the `_build/html//index.html` file, where `` is " "the language you have been working on." msgstr "" -"`_build/html//index.html` ファイルを開いて、翻訳版のガイドがブラウザでうまく表示されることを確認してください。 " -"`` は作業中の言語です。" +"`_build/html//index.html` " +"ファイルを開いて、翻訳版のガイドがブラウザでうまく表示されることを確認してください。 `` は作業中の言語です。" #: ../../TRANSLATING.md:260 msgid "If everything looks good, you can submit a PR with your changes." @@ -571,7 +571,8 @@ msgstr "" "というタグが付けられます。" #: ../../TRANSLATING.md:268 -msgid "TODO: This tagging could be automated with a GitHub action." +#, fuzzy +msgid "TODO: This tagging could be automated with a GitHub Actions." msgstr "TODO: このタグ付けは、GitHubのアクションで自動化できるかもしれません。" #: ../../TRANSLATING.md:270 @@ -580,8 +581,7 @@ msgid "" "changes you made and any context that might be helpful for the reviewer " "(e.g., you translated new strings, you reviewed fuzzy entries, you fixed " "typos, etc.)" -msgstr "" -"PRを提出する際には、あなたが行った変更についての簡単な説明と、レビュアーにとって参考になりそうな文脈（新しい文字列を翻訳した、あいまいなエントリーを見直した、誤字脱字を修正した、など）を必ず含めてください。" +msgstr "PRを提出する際には、あなたが行った変更についての簡単な説明と、レビュアーにとって参考になりそうな文脈（新しい文字列を翻訳した、あいまいなエントリーを見直した、誤字脱字を修正した、など）を必ず含めてください。" #: ../../TRANSLATING.md:272 msgid "The Review Process" @@ -610,7 +610,8 @@ msgid "" " make sure they are accurate and consistent with the style and tone of " "the guide." msgstr "" -"各言語には担当エディターがおり、翻訳投稿の確認と統合を担当します。 エディターは、変更が正確で、ガイドのスタイルやトーンと一致していることを確認します。" +"各言語には担当エディターがおり、翻訳投稿の確認と統合を担当します。 " +"エディターは、変更が正確で、ガイドのスタイルやトーンと一致していることを確認します。" #: ../../TRANSLATING.md:280 msgid "" @@ -627,8 +628,7 @@ msgid "" "When the editor is satisfied with the translation, they will merge the " "PR. The translated version of the guide will be available on the " "pyOpenSci website once the language is released." -msgstr "" -"エディターが翻訳に満足したら、PRをマージします。ガイドの翻訳版は言語がリリースされ次第、pyOpenSciのウェブサイトから入手できます。" +msgstr "エディターが翻訳に満足したら、PRをマージします。ガイドの翻訳版は言語がリリースされ次第、pyOpenSciのウェブサイトから入手できます。" #: ../../TRANSLATING.md:284 msgid "The Release Process" @@ -648,8 +648,7 @@ msgid "" "When the guide is built for release in CI, Sphinx will also generate the " "translated versions of the guide for the languages in the " "`RELEASE_LANGUAGES` list." -msgstr "" -"ガイドがCIでリリース用にビルドされると、Sphinxは `RELEASE_LANGUAGES` リストにある言語の翻訳版のガイドも生成します。" +msgstr "ガイドがCIでリリース用にビルドされると、Sphinxは `RELEASE_LANGUAGES` リストにある言語の翻訳版のガイドも生成します。" #: ../../TRANSLATING.md:290 msgid "" @@ -685,12 +684,14 @@ msgid "What happens when a string has changed in the original English text?" msgstr "英語の原文で文字列が変更された場合はどうなりますか？" #: ../../TRANSLATING.md:300 +#, fuzzy msgid "" "If a string has changed in the original English version, it will be " "marked as `fuzzy` in the translation file the next time it is updated " -"(`nox -s update-translations`). Contributors working on the translation " -"can then review the fuzzy entries and make the necessary changes to " -"ensure it is accurate, before removing the `fuzzy` tag." +"(`update-language`, `update-all-languages`, or `update-all-release-" +"languages`). Contributors working on the translation can then review the " +"fuzzy entries and make the necessary changes to ensure it is accurate, " +"before removing the `fuzzy` tag." msgstr "" "オリジナルの英語版で文字列が変更された場合、次に翻訳ファイルが更新されるとき（ `nox -s update-translations` ）に " "`fuzzy` としてマークされます。 翻訳に携わっているコントリビューターは、 `fuzzy` " @@ -724,9 +725,9 @@ msgid "" "the bold formatting in the translated text but update the text inside the" " formatting tags to `**Prueba casos especiales:**`." msgstr "" -"翻訳されたテキストの書式はそのままにして、書式タグの中のテキストも翻訳してください。 たとえば、元の英語のテキストが `**Test special " -"cases:**` の場合、翻訳されたテキストでは太字の書式を維持しますが、書式タグ内のテキストを `**特殊ケーステスト:**` " -"に更新する必要があります。" +"翻訳されたテキストの書式はそのままにして、書式タグの中のテキストも翻訳してください。 たとえば、元の英語のテキストが `**Test " +"special cases:**` の場合、翻訳されたテキストでは太字の書式を維持しますが、書式タグ内のテキストを `**特殊ケーステスト:**`" +" に更新する必要があります。" #: ../../TRANSLATING.md:310 msgid "How do I handle strings that are too long for a single line?" @@ -739,8 +740,8 @@ msgid "" "indicated by an empty string in the `msgid` and `msgstr` fields, followed" " by the continuation of the text in the next line. For example:" msgstr "" -"元の英文が長すぎて1行に収まらない場合は、複数行に分けることができます。 `.po` ファイル内の複数行の文字列は `msgid` と `msgstr`" -" フィールドに空の文字列を入れ、その後に次の行のテキストの続きを入れることで示されます。 例えば:" +"元の英文が長すぎて1行に収まらない場合は、複数行に分けることができます。 `.po` ファイル内の複数行の文字列は `msgid` と " +"`msgstr` フィールドに空の文字列を入れ、その後に次の行のテキストの続きを入れることで示されます。 例えば:" #: ../../TRANSLATING.md:325 msgid "How do I translate images?" @@ -763,8 +764,7 @@ msgid "" "In some special cases, an image might be critical to the understanding of" " the content. In those cases, the translations will be handled by the " "maintainers and editors outside this workflow." -msgstr "" -"特殊なケースでは、画像がコンテンツの理解に不可欠な場合があります。 そのような場合、翻訳はこのワークフロー外のメンテナやエディタが担当します。" +msgstr "特殊なケースでは、画像がコンテンツの理解に不可欠な場合があります。 そのような場合、翻訳はこのワークフロー外のメンテナやエディタが担当します。" #: ../../TRANSLATING.md:331 msgid "" @@ -808,8 +808,7 @@ msgid "" "TODO: There are many approaches here, some projects release a translation" " as soon as some strings are translated, others wait until a certain " "percentage of the content is translated." -msgstr "" -"TODO：ここにはさまざまなアプローチがあります。あるプロジェクトでは、いくつかの文字列が翻訳されるとすぐに翻訳をリリースしますし、ある一定の割合のコンテンツが翻訳されるまで待つプロジェクトもあります。" +msgstr "TODO：ここにはさまざまなアプローチがあります。あるプロジェクトでは、いくつかの文字列が翻訳されるとすぐに翻訳をリリースしますし、ある一定の割合のコンテンツが翻訳されるまで待つプロジェクトもあります。" #: ../../TRANSLATING.md:341 msgid "How can I get help with my translation?" @@ -818,15 +817,37 @@ msgstr "翻訳を手伝ってもらうにはどうすればよいですか？" #: ../../TRANSLATING.md:343 msgid "" "If you have any questions or need help with your translation, you can " -"create an issue in the repository if you encounter any problems or need " -"assistance." -msgstr "もし翻訳で何か問題が発生したり、サポートが必要な場合は、リポジトリに課題を作成することができます。" +"create an [issue](https://github.com/pyOpenSci/python-package-" +"guide/issues) in the [Packaging Guide " +"repository](https://github.com/pyOpenSci/python-package-guide)" +msgstr "" #: ../../TRANSLATING.md:345 msgid "" -"TODO: Maybe [Discourse](https://pyopensci.discourse.group/) could be used" -" as a way for contributors to ask for help with translations or the " -"translation workflow?" -msgstr "" -"TODO: [Discourse](https://pyopensci.discourse.group/) " -"を、投稿者が翻訳や翻訳ワークフローについて助けを求める方法として使うことができるかもしれません。" +"You can also ask in the PyOpenSci Discord server ([click " +"here](https://discord.gg/CvSMp4zcqX) to join), you will find a general " +"channel for questions related to our workflow, processes, and tools " +"(translation-general) and channels for each of the languages we are " +"working on (spanish-translation, japanese-translation, etc)." +msgstr "" + +#~ msgid "You can do this by running the following command:" +#~ msgstr "次のコマンドを実行すれば可能です:" + +#~ msgid "" +#~ "If you have any questions or need" +#~ " help with your translation, you can" +#~ " create an issue in the repository" +#~ " if you encounter any problems or " +#~ "need assistance." +#~ msgstr "もし翻訳で何か問題が発生したり、サポートが必要な場合は、リポジトリに課題を作成することができます。" + +#~ msgid "" +#~ "TODO: Maybe " +#~ "[Discourse](https://pyopensci.discourse.group/) could be" +#~ " used as a way for contributors " +#~ "to ask for help with translations " +#~ "or the translation workflow?" +#~ msgstr "" +#~ "TODO: [Discourse](https://pyopensci.discourse.group/) " +#~ "を、投稿者が翻訳や翻訳ワークフローについて助けを求める方法として使うことができるかもしれません。" diff --git a/locales/ja/LC_MESSAGES/documentation.po b/locales/ja/LC_MESSAGES/documentation.po index 3ae706213..11679eb1c 100644 --- a/locales/ja/LC_MESSAGES/documentation.po +++ b/locales/ja/LC_MESSAGES/documentation.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,7 +18,7 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" #: ../../documentation/hosting-tools/intro.md:1 msgid "Tools to Build and Host your Documentation" @@ -89,15 +89,16 @@ msgstr "" "**rST**は、sphinxがサポートするネイティブの構文です。rSTは、長年ドキュメントに使用されてきたデフォルトの構文です。しかし、近年、mySTがその柔軟性から、ドキュメンテーションによく使われるようになりました。" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:9 +#, fuzzy msgid "" "[myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) myST is " -"a combination of vanilla of `markdown` and `rST` syntax. It is a nice " -"option if you are comfortable writing markdown. `myst` is preferred by " -"many because it offers both the rich functionality of rST combined with a" -" simple-to-write markdown syntax." +"a combination of `markdown` and `rST` syntax. It is a nice option if you " +"are comfortable writing markdown. `myst` is preferred by many because it " +"offers both the rich functionality of rST combined with a simple-to-write" +" markdown syntax." msgstr "" -"[myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) mySTは普通の " -"`markdown` と `rST` の構文の組み合わせです。 もしあなたがマークダウンを書くのに慣れているのであれば、良いオプションです。 " +"[myST:](https://myst-parser.readthedocs.io/en/latest/intro.html) mySTは普通の" +" `markdown` と `rST` の構文の組み合わせです。 もしあなたがマークダウンを書くのに慣れているのであれば、良いオプションです。 " "myst`はrSTの豊富な機能と書きやすいマークダウン構文の両方を提供するため、多くの人に好まれています。" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:12 @@ -126,8 +127,7 @@ msgstr "README.mdファイルなど、Pythonパッケージのコアとなるテ msgid "" "`GitHub` and `Jupyter Notebooks` support markdown thus it's more widely " "used in the scientific ecosystem." -msgstr "" -"`GitHub` と `Jupyter Notebooks` はMarkdownをサポートしており、科学的なエコシステムでより広く使われています。" +msgstr "`GitHub` と `Jupyter Notebooks` はMarkdownをサポートしており、科学的なエコシステムでより広く使われています。" #: ../../documentation/hosting-tools/myst-markdown-rst-doc-syntax.md:22 msgid "" @@ -201,8 +201,7 @@ msgid "" "Supports versioning of your documentation which allows users to refer to " "older tagged versions of the docs if they are using older versions of " "your package." -msgstr "" -"ドキュメントのバージョン管理をサポートし、ユーザーが古いバージョンのパッケージを使用している場合、タグ付けされた古いバージョンのドキュメントを参照できるようにします。" +msgstr "ドキュメントのバージョン管理をサポートし、ユーザーが古いバージョンのパッケージを使用している場合、タグ付けされた古いバージョンのドキュメントを参照できるようにします。" #: ../../documentation/hosting-tools/publish-documentation-online.md:20 msgid "Supports downloading of documentation in PDF and other formats." @@ -226,10 +225,10 @@ msgid "" "using a Continuous Integration setup, and then push to a branch in your " "GitHub repository that is setup to run the GitHub Pages web build." msgstr "" -"[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-github-" -"pages/about-github-pages) は GitHub が提供する無料のウェブホスティングサービスです。 GitHub Pages " -"を使えば、ローカルあるいは継続的インテグレーションを使ってドキュメントをビルドし、GitHub Pages のウェブビルドを実行するように設定した " -"GitHub リポジトリのブランチにプッシュすることができます。" +"[GitHub Pages](https://docs.github.com/en/pages/getting-started-with-" +"github-pages/about-github-pages) は GitHub が提供する無料のウェブホスティングサービスです。 GitHub" +" Pages を使えば、ローカルあるいは継続的インテグレーションを使ってドキュメントをビルドし、GitHub Pages " +"のウェブビルドを実行するように設定した GitHub リポジトリのブランチにプッシュすることができます。" #: ../../documentation/hosting-tools/publish-documentation-online.md:33 msgid "Read the Docs vs GitHub Pages" @@ -274,8 +273,8 @@ msgid "" msgstr "" "このページでは、 [Sphinx](https://www.sphinx-doc.org/) " "を使ってユーザー向けのパッケージのドキュメントをビルドする方法について説明します。 " -"Sphinxは科学的なPythonのエコシステムで現在最もよく使われているツールですが、Pythonのパッケージングエコシステムで人気を集めている " -"[mkdocs](https://www.mkdocs.org/) のような、ドキュメントをビルドするための他のツールを調べることも歓迎します。" +"Sphinxは科学的なPythonのエコシステムで現在最もよく使われているツールですが、Pythonのパッケージングエコシステムで人気を集めている" +" [mkdocs](https://www.mkdocs.org/) のような、ドキュメントをビルドするための他のツールを調べることも歓迎します。" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:25 msgid "Examples of documentation websites that we love:" @@ -289,8 +288,7 @@ msgstr "[GeoPandas](https://geopandas.org/en/stable/)" msgid "" "[View rst to create landing " "page](https://raw.githubusercontent.com/geopandas/geopandas/main/doc/source/index.rst)" -msgstr "" -"[ランディングページを作成するために最初にご覧ください](https://raw.githubusercontent.com/geopandas/geopandas/main/doc/source/index.rst)" +msgstr "[ランディングページを作成するために最初にご覧ください](https://raw.githubusercontent.com/geopandas/geopandas/main/doc/source/index.rst)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:29 msgid "[verde](https://www.fatiando.org/verde/latest/)" @@ -310,8 +308,8 @@ msgid "" " page.](https://github.com/pyOpenSci/python-package-" "guide/blob/main/index.md)" msgstr "" -"[ランディングページのmyST例をご覧になりたい方は、こちらのドキュメントをご覧ください](https://github.com/pyOpenSci/python-" -"package-guide/blob/main/index.md)" +"[ランディングページのmyST例をご覧になりたい方は、こちらのドキュメントをご覧ください](https://github.com/pyOpenSci" +"/python-package-guide/blob/main/index.md)" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:34 msgid "Sphinx - a static site generator" @@ -327,8 +325,9 @@ msgid "" " the files on the fly." msgstr "" "Sphinxは " -"[スタティックサイトジェネレーター](https://www.cloudflare.com/learning/performance/static-" -"site-generator/) です。 静的サイトジェネレータとは、テンプレートのセットに基づいて、ウェブサイトのhtmlを作成するツールです。 " +"[スタティックサイトジェネレーター](https://www.cloudflare.com/learning/performance" +"/static-site-generator/) です。 " +"静的サイトジェネレータとは、テンプレートのセットに基づいて、ウェブサイトのhtmlを作成するツールです。 " "htmlファイルは「静的」に提供されるため、その場でファイルを生成したり変更したりすることはありません。" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:39 @@ -344,7 +343,6 @@ msgid "" "The functionality of Sphinx can be extended using extensions and themes. " "A few examples include:" msgstr "" -msgstr "Sphinxの機能は、エクステンションやテーマを使って拡張することができます。 いくつかの例があります:" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:46 msgid "" @@ -359,8 +357,8 @@ msgid "" "autodoc extension](https://www.sphinx-" "doc.org/en/master/usage/extensions/autodoc.html)" msgstr "" -"[autodocエクステンションを使って、パッケージの関数やクラス(パッケージのAPI)のドキュメントをコードのdocstringから自動的に作成する](https://www.sphinx-" -"doc.org/en/master/usage/extensions/autodoc.html) ことができます。" +"[autodocエクステンションを使って、パッケージの関数やクラス(パッケージのAPI)のドキュメントをコードのdocstringから自動的に作成する](https://www" +".sphinx-doc.org/en/master/usage/extensions/autodoc.html) ことができます。" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:48 msgid "" @@ -372,13 +370,15 @@ msgstr "" "doc.org/en/master/usage/extensions/doctest.html) ことができます。" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:49 +#, fuzzy msgid "" -"While Sphinx natively supports the `rST` syntax. You can add custom " +"While Sphinx natively supports the `rST` syntax, you can add custom " "syntax parsers to support easier-to-write syntax using tools such as [the" " MyST parser](https://myst-parser.readthedocs.io/)." msgstr "" "[MySTパーサー](https://myst-parser.readthedocs.io/) " -"などのツールを使って、書きやすい構文をサポートするカスタム構文パーサーを追加できます。Sphinxはネイティブで `rST` 構文をサポートしています。" +"などのツールを使って、書きやすい構文をサポートするカスタム構文パーサーを追加できます。Sphinxはネイティブで `rST` " +"構文をサポートしています。" #: ../../documentation/hosting-tools/sphinx-python-package-documentation-tools.md:51 msgid "Commonly used Sphinx themes" @@ -418,8 +418,7 @@ msgid "" "If you are interested in more people finding your package, you may want " "to add some core Sphinx extensions (and theme settings) that will help " "search engines such as Google find your documentation." -msgstr "" -"もし、より多くの人にあなたのパッケージを見つけてもらいたいのであれば、Sphinxのコアとなる拡張機能(およびテーマの設定)を追加することで、Googleなどの検索エンジンがあなたのドキュメントを見つけやすくすることができます。" +msgstr "もし、より多くの人にあなたのパッケージを見つけてもらいたいのであれば、Sphinxのコアとなる拡張機能(およびテーマの設定)を追加することで、Googleなどの検索エンジンがあなたのドキュメントを見つけやすくすることができます。" #: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:7 msgid "Google Analytics" @@ -465,10 +464,11 @@ msgid "" msgstr "" "[`pydata-sphinx-theme`や `sphinx-book-theme` のようなsphinxテーマには、Google " "Analyticsのサポートが組み込まれています](https://pydata-sphinx-" -"theme.readthedocs.io/en/latest/user_guide/analytics.html#google-analytics) " -"。しかし、もしあなたが選んだテーマがGoogle Analyticsをサポートしていない場合は、 [sphinxcontrib-gtagjs` " -"extension](https://github.com/attakei/sphinxcontrib-gtagjs) を使うことができます。 " -"このエクステンションは、Google Analyticsのサイトタグをドキュメントの各ページに追加します。" +"theme.readthedocs.io/en/latest/user_guide/analytics.html#google-" +"analytics) 。しかし、もしあなたが選んだテーマがGoogle Analyticsをサポートしていない場合は、 " +"[sphinxcontrib-gtagjs` extension](https://github.com/attakei" +"/sphinxcontrib-gtagjs) を使うことができます。 このエクステンションは、Google " +"Analyticsのサイトタグをドキュメントの各ページに追加します。" #: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:22 msgid "" @@ -511,29 +511,29 @@ msgid "" "and site your documentation base url](https://sphinx-" "sitemap.readthedocs.io/en/latest/getting-started.html)." msgstr "" -"これは、 [Sphinxの `conf.py` " -"拡張機能リストに追加し、ドキュメントのベースURLを指定する必要があります](https://sphinx-" -"sitemap.readthedocs.io/en/latest/getting-started.html) 。" +"これは、 [Sphinxの `conf.py` 拡張機能リストに追加し、ドキュメントのベースURLを指定する必要があります](https" +"://sphinx-sitemap.readthedocs.io/en/latest/getting-started.html) 。" #: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:40 msgid "[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)" -msgstr "" -"[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)" +msgstr "[sphinxext.opengraph](https://github.com/wpilibsuite/sphinxext-opengraph)" #: ../../documentation/hosting-tools/website-hosting-optimizing-your-docs.md:42 +#, fuzzy msgid "" "OpenGraph is an extension that allows you to add metadata to your " "documentation content pages. [The OpenGraph protocol allows other " "websites to provide a useful preview of the content on your page when " "shared](https://www.freecodecamp.org/news/what-is-open-graph-and-how-" -"can-i-use-it-for-my-website/#what-is-open-graph). This is important for " -"when the pages in your documentation are shared on social media sites " -"like Twitter and Mastodon and even for shares on tools like Slack and " -"Discourse." +"can-i-use-it-for-my-website/#heading-what-is-open-graph). This is " +"important for when the pages in your documentation are shared on social " +"media sites like Twitter and Mastodon and even for shares on tools like " +"Slack and Discourse." msgstr "" "OpenGraphは、ドキュメントのコンテンツページにメタデータを追加できる拡張機能です。 " -"[OpenGraphプロトコルは、共有されたときに他のウェブサイトがあなたのページのコンテンツの有用なプレビューを提供することを可能にします](https://www.freecodecamp.org/news/what-" -"is-open-graph-and-how-can-i-use-it-for-my-website/#what-is-open-graph) 。 " +"[OpenGraphプロトコルは、共有されたときに他のウェブサイトがあなたのページのコンテンツの有用なプレビューを提供することを可能にします](https://www.freecodecamp.org/news" +"/what-is-open-graph-and-how-can-i-use-it-for-my-website/#what-is-open-" +"graph) 。 " "これは、あなたのドキュメントのページがTwitterやMastodonのようなソーシャルメディアサイトで共有されるときや、SlackやDiscourseのようなツールで共有されるときにも重要です。" #: ../../documentation/index.md:3 @@ -703,8 +703,7 @@ msgstr "研究用アプリケーションでコードを使用する場合、あ msgid "" "Information on the license that your code uses so they know how they can " "or can't use the code in an operational setting." -msgstr "" -"あなたのコードが使用するライセンスに関する情報を提供することで、運用環境においてコードをどのように使用できるか、または使用できないかを知ってもらいます。" +msgstr "あなたのコードが使用するライセンスに関する情報を提供することで、運用環境においてコードをどのように使用できるか、または使用できないかを知ってもらいます。" #: ../../documentation/index.md:96 msgid "2. Potential tool contributors" @@ -714,8 +713,7 @@ msgstr "2. ツールコントリビュータ候補" msgid "" "The other subset of users are more experienced and/or more engaged with " "your package. As such they are potential contributors. These users:" -msgstr "" -"もう一組のユーザは、経験が豊富で、かつ/またはあなたのパッケージにより深く関わっています。 彼らは潜在的な貢献者です。 これらのユーザーは:" +msgstr "もう一組のユーザは、経験が豊富で、かつ/またはあなたのパッケージにより深く関わっています。 彼らは潜在的な貢献者です。 これらのユーザーは:" #: ../../documentation/index.md:102 msgid "might have a software development background," @@ -761,8 +759,7 @@ msgid "" "report. Or fixing a spelling issue in your documentation. Or it could be " "a code fix that includes a new test that covers an edge-case that they " "discovered." -msgstr "" -"重要なのは、貢献の定義は幅広いということを覚えておくことです。貢献とは、バグ報告のような単純なものでもよいのです。あるいは、ドキュメントのスペルの問題を修正する。あるいは、彼らが発見したエッジケースをカバーする新しいテストを含むコード修正かもしれません。" +msgstr "重要なのは、貢献の定義は幅広いということを覚えておくことです。貢献とは、バグ報告のような単純なものでもよいのです。あるいは、ドキュメントのスペルの問題を修正する。あるいは、彼らが発見したエッジケースをカバーする新しいテストを含むコード修正かもしれません。" #: ../../documentation/index.md:120 msgid "Documentation elements that pyOpenSci looks for reviewing a Python package" @@ -774,8 +771,7 @@ msgid "" "that supports both your tool users and potential contributors. The files " "and elements that we look for specifically can be found in our peer " "review check list (see link below)." -msgstr "" -"pyOpenSciオープンピアレビューでは、あなたのツールのユーザーと潜在的な貢献者の両方をサポートする文書構造を探します。私たちが特にチェックするファイルや要素は、査読チェックリスト（下記リンク参照）に記載されています。" +msgstr "pyOpenSciオープンピアレビューでは、あなたのツールのユーザーと潜在的な貢献者の両方をサポートする文書構造を探します。私たちが特にチェックするファイルや要素は、査読チェックリスト（下記リンク参照）に記載されています。" #: ../../documentation/index.md:127 msgid "" @@ -1050,15 +1046,15 @@ msgstr "" "この例はpyOpenSci受諾パッケージの [Devicely](https://github.com/hpi-" "dhc/devicely/blob/main/CHANGELOG.md) から来ています。" -#: ../../documentation/repository-files/code-of-conduct-file.md:1 +#: ../../documentation/repository-files/code-of-conduct-file.md:3 msgid "The CODE_OF_CONDUCT file - Python Packaging" msgstr "CODE_OF_CONDUCT ファイル - Python Packaging" -#: ../../documentation/repository-files/code-of-conduct-file.md:3 +#: ../../documentation/repository-files/code-of-conduct-file.md:5 msgid "Example CODE_OF_CONDUCT files" msgstr "CODE_OF_CONDUCT ファイルの例" -#: ../../documentation/repository-files/code-of-conduct-file.md:6 +#: ../../documentation/repository-files/code-of-conduct-file.md:8 msgid "" "[SciPy Code of Conduct file - notice they included theirs in their " "documentation](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)" @@ -1066,14 +1062,13 @@ msgstr "" "[SciPyの行動規範ファイル - " "彼らのドキュメントに含まれていることに注目](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)" -#: ../../documentation/repository-files/code-of-conduct-file.md:7 +#: ../../documentation/repository-files/code-of-conduct-file.md:9 msgid "" "[fatiando CODE_OF_CONDUCT.md " "file](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)" -msgstr "" -"[fatiandoのCODE_OF_CONDUCT.mdファイル](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)" +msgstr "[fatiandoのCODE_OF_CONDUCT.mdファイル](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)" -#: ../../documentation/repository-files/code-of-conduct-file.md:10 +#: ../../documentation/repository-files/code-of-conduct-file.md:12 msgid "" "Your package should have a `CODE_OF_CONDUCT.md` file located the root of " "the repository. Once you have people using your package, you can consider" @@ -1086,7 +1081,7 @@ msgstr "" "このコミュニティの一部は、あなたのツールを使っています。 " "このようなユーザは、あなたのパッケージを使用する際に質問をしたり、問題に遭遇するかもしれません。" -#: ../../documentation/repository-files/code-of-conduct-file.md:16 +#: ../../documentation/repository-files/code-of-conduct-file.md:18 msgid "" "Others in the community might want to contribute to your tool. They might" " fix bugs, update documentation and engage with the maintainer team." @@ -1094,20 +1089,21 @@ msgstr "" "コミュニティの他の人たちも、あなたのツールに貢献したいと思うかもしれません。 " "バグを修正したり、ドキュメントを更新したり、メンテナチームと関わりを持ったりするかもしれません。" -#: ../../documentation/repository-files/code-of-conduct-file.md:20 +#: ../../documentation/repository-files/code-of-conduct-file.md:22 msgid "Why you need a CODE_OF_CONDUCT" msgstr "CODE_OF_CONDUCTが必要な理由" -#: ../../documentation/repository-files/code-of-conduct-file.md:22 +#: ../../documentation/repository-files/code-of-conduct-file.md:24 msgid "" "In order to keep this community healthy and to protect yourself, your " "maintainer team and your users from unhealthy behavior, it is important " "to have a [`CODE_OF_CONDUCT`](https://opensource.guide/code-of-conduct/)." msgstr "" "このコミュニティを健全に保ち、あなた自身、あなたのメンテナチーム、そしてユーザーを不健全な行動から守るためには、 " -"[`CODE_OF_CONDUCT`](https://opensource.guide/code-of-conduct/) を持つことが重要です。" +"[`CODE_OF_CONDUCT`](https://opensource.guide/code-of-conduct/) " +"を持つことが重要です。" -#: ../../documentation/repository-files/code-of-conduct-file.md:26 +#: ../../documentation/repository-files/code-of-conduct-file.md:28 msgid "" "The `CODE_OF_CONDUCT` is important as it establishes what you expect in " "terms of how users and contributors interact with maintainers and each " @@ -1119,7 +1115,7 @@ msgstr "" "は、利用者や貢献者がメンテナや他の利用者とどのように交流するかという点で、あなたが期待することを定めるものとして重要です。 " "また、有害な行動や否定的な行動から他の人を守るために、必要であれば強制することができる規則や期待も確立します。" -#: ../../documentation/repository-files/code-of-conduct-file.md:32 +#: ../../documentation/repository-files/code-of-conduct-file.md:34 msgid "" "If you are not comfortable with creating your own `CODE_OF_CONDUCT` text," " we encourage you to adopt the `CODE_OF_CONDUCT` language used in the " @@ -1131,88 +1127,240 @@ msgid "" "here.](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)" msgstr "" "あなた自身の `CODE_OF_CONDUCT` の文章を作成することに抵抗がある場合、 [Contributor " -"Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)" -" で使用されている `CODE_OF_CONDUCT` の文言を採用することをお勧めします。 " -"[他の多くのコミュニティ](https://www.contributor-covenant.org/adopters/) はこの " -"`CODE_OF_CONDUCT` を自分たちのものとして採用しています。 [Fatiando Terra Geoscience " +"Covenant](https://www.contributor-" +"covenant.org/version/2/1/code_of_conduct/) で使用されている `CODE_OF_CONDUCT` " +"の文言を採用することをお勧めします。 [他の多くのコミュニティ](https://www.contributor-" +"covenant.org/adopters/) はこの `CODE_OF_CONDUCT` を自分たちのものとして採用しています。 " +"[Fatiando Terra Geoscience " "Pythonコミュニティの例はこちら](https://github.com/fatiando/community/blob/main/CODE_OF_CONDUCT.md)" " を参照してください。" -#: ../../documentation/repository-files/contributing-file.md:1 -msgid "Contributing File in your Python Open Source Package" -msgstr "Pythonオープンソースパッケージにファイルを貢献する" +#: ../../documentation/repository-files/contributing-file.md:2 +#, fuzzy +msgid "Your Python Package CONTRIBUTING File" +msgstr "貢献ファイルの例" + +#: ../../documentation/repository-files/contributing-file.md:4 +msgid "" +"The **CONTRIBUTING.md** is the landing page guide for your project's " +"contributors. It outlines how contributors can get involved, the " +"contribution types that you welcome, and how contributors should interact" +" or engage with you and your maintainer team. The contributor guide " +"should also link to get-started resources that overview how to set up " +"development environments, what type of workflow you expect on " +"GitHub/GitLab, and anything else that contributors might need to get " +"started." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:6 +msgid "" +"This file benefits maintainers and contributors. For contributors, it " +"provides a roadmap that helps them get started and makes their first " +"contribution easier. For maintainers, it answers commonly asked questions" +" and reduces the burden of explaining your process to every person who " +"wants to contribute. This document creates a more collaborative and " +"efficient development process for everyone." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:8 +msgid "CONTRIBUTING files lower barriers to entry" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:10 +msgid "" +"The contributing file lowers barriers to entry for new and seasoned " +"contributors as it provides a roadmap." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:12 +msgid "" +"**For Contributors**: It provides clear instructions on contributing, " +"from reporting issues to submitting pull requests." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:13 +msgid "" +"**For Maintainers**: It streamlines contributions by setting expectations" +" and standardizing processes, reducing the time spent clarifying common " +"questions or handling incomplete issues or pull requests." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:15 +msgid "" +"Including a well-written CONTRIBUTING.md file in your project is one way " +"of making it more welcoming and open to new and seasoned contributors. It" +" also helps create a smoother workflow for everyone involved." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:17 +msgid "Make it welcoming" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:19 +msgid "" +"Make the guide welcoming. Use accessible language to encourage " +"participation from contributors of all experience levels. For example:" +msgstr "" -#: ../../documentation/repository-files/contributing-file.md:3 +#: ../../documentation/repository-files/contributing-file.md:21 +msgid "" +"Avoid technical jargon or explain terms when necessary (for example, " +"\"fork the repository\")." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:22 +msgid "" +"Include a friendly introduction, such as \"Thank you for your interest in" +" contributing! We're excited to collaborate with you.\"" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:23 +msgid "Highlight that all contributions, no matter how small, are valued." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:25 msgid "What a CONTRIBUTING.md file should contain" msgstr "CONTRIBUTING.md ファイルが含むべき内容" -#: ../../documentation/repository-files/contributing-file.md:5 +#: ../../documentation/repository-files/contributing-file.md:27 msgid "Example contributing files" msgstr "貢献ファイルの例" -#: ../../documentation/repository-files/contributing-file.md:8 +#: ../../documentation/repository-files/contributing-file.md:30 +#, fuzzy msgid "" -"[pyGMT contributing " +"[PyGMT contributing " "file](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md)" msgstr "" "[pyGMT " "貢献ファイル](https://github.com/GenericMappingTools/pygmt/blob/main/CONTRIBUTING.md)" -#: ../../documentation/repository-files/contributing-file.md:9 +#: ../../documentation/repository-files/contributing-file.md:31 +#, fuzzy msgid "" -"[fatiando verde's contributing " +"[Verde's contributing " "file](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md)" msgstr "" "[fatiando " "verdeの貢献ファイル](https://github.com/fatiando/verde/blob/main/CONTRIBUTING.md)" -#: ../../documentation/repository-files/contributing-file.md:12 +#: ../../documentation/repository-files/contributing-file.md:34 +#, fuzzy msgid "" -"Your Python open source package should include a file called " -"**CONTRIBUTING.md** located in the root of your repository (with your " -"**README.md** file)." +"Your Python package should include a file called **CONTRIBUTING.md** " +"located in the root of your repository next to [your **README.md** file" +"](readme-file)." msgstr "" "あなたのPythonオープンソースパッケージは、リポジトリのルートに **CONTRIBUTING.md** というファイルを含むべきです（ " "**README.md** ファイルと一緒に）。" -#: ../../documentation/repository-files/contributing-file.md:15 +#: ../../documentation/repository-files/contributing-file.md:37 +#, fuzzy +msgid "The CONTRIBUTING.md file should include information about:" +msgstr "CONTRIBUTING.md ファイルが含むべき内容" + +#: ../../documentation/repository-files/contributing-file.md:39 +msgid "The types of contributions that you welcome" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:41 msgid "" -"The contributing file should include information about the types of " -"contributions that you welcome, and how you'd like to see contributions " -"happen." -msgstr "貢献ファイルには、歓迎する貢献の種類や、どのように貢献してほしいかについての情報を記載します。" +"Example: We welcome contributions of all kinds. If you want to address an" +" existing issue, check out our issues in this repository and comment on " +"the one that you'd like to help with. Otherwise, you can open a new " +"issue..." +msgstr "" -#: ../../documentation/repository-files/contributing-file.md:19 +#: ../../documentation/repository-files/contributing-file.md:43 msgid "" -"This guide should also include information for someone interested in " -"asking questions, submitting issues or pull requests. It should have " -"things like:" +"How you'd like contributions to happen. Clearly outline your contribution" +" process. For example:" msgstr "" -"このガイドには、質問や課題の提出、プルリクエストに興味がある人のための情報も含まれていなければなりません。 以下のようなことが書かれているべきです:" -#: ../../documentation/repository-files/contributing-file.md:22 +#: ../../documentation/repository-files/contributing-file.md:44 +msgid "Should contributors address open issues" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:45 +msgid "Are new issues welcome?" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:46 msgid "" -"Any guidelines that you have in place for users submitting issues, pull " -"requests or asking questions." +"Should contributors open a pull request (PR) directly or discuss changes " +"first?" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:48 +msgid "" +"Include instructions for the fork and pull request workflow and link to " +"resources or guides explaining these steps (if available)." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:49 +#, fuzzy +msgid "" +"Guidelines that you have in place for users submitting issues, pull " +"requests, or asking questions." msgstr "課題、プルリクエスト、質問を提出するユーザーに対して設けているガイドライン。" -#: ../../documentation/repository-files/contributing-file.md:23 -msgid "A link to your code of conduct" +#: ../../documentation/repository-files/contributing-file.md:51 +msgid "" +"If you have a [development guide](development-guide), link to it. This " +"guide should provide clear instructions on how to set up your development" +" environment locally. It also should overview CI tools that you have that" +" could simplify the contribution process (for example, pre-[commit.ci " +"bot](https://www.pyopensci.org/python-package-guide/package-structure-" +"code/code-style-linting-format.html#pre-commit-ci), and so on), [linters," +" code formatters](https://www.pyopensci.org/python-package-guide/package-" +"structure-code/code-style-linting-format.html#code-linting-formatting-" +"and-styling-tools), and so on." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:53 +msgid "" +"This guide should also include information for someone interested in " +"asking questions. Some projects accept questions as GitHub or GitLab " +"issues. Others use GitHub discussions, Discourse, or even a Discord " +"server." +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:56 +#, fuzzy +msgid "The contributing file should also include:" +msgstr "CONTRIBUTING.md ファイルが含むべき内容" + +#: ../../documentation/repository-files/contributing-file.md:58 +#, fuzzy +msgid "A link to your [code of conduct](coc-file)" msgstr "行動規範へのリンク" -#: ../../documentation/repository-files/contributing-file.md:24 -msgid "A link to licensing information found in your README file." -msgstr "READMEファイルにあるライセンス情報へのリンク。" +#: ../../documentation/repository-files/contributing-file.md:59 +msgid "A link to your project's [LICENSE](license-file)" +msgstr "" -#: ../../documentation/repository-files/contributing-file.md:25 -msgid "A link to a development guide if you have one" +#: ../../documentation/repository-files/contributing-file.md:60 +#, fuzzy +msgid "A link to a [development guide](development-guide) if you have one" msgstr "もしあれば開発ガイドへのリンク" -#: ../../documentation/repository-files/development-guide.md:1 +#: ../../documentation/repository-files/contributing-file.md:62 +msgid "Summary" +msgstr "" + +#: ../../documentation/repository-files/contributing-file.md:64 +msgid "" +"A well-crafted CONTRIBUTING.md file is welcome mat for your project! By " +"providing clear instructions, helpful resources, and a welcoming tone, " +"you make it easier for contributors to get involved and build a stronger," +" more collaborative community around your project." +msgstr "" + +#: ../../documentation/repository-files/development-guide.md:2 msgid "What the development guide for your Python package should contain" msgstr "Pythonパッケージの開発ガイドに含めるべき内容" -#: ../../documentation/repository-files/development-guide.md:3 +#: ../../documentation/repository-files/development-guide.md:4 msgid "" "Ideally, your package should also have a development guide. This file may" " live in your package documentation and should be linked to from your " @@ -1220,96 +1368,93 @@ msgid "" "clearly show technically proficient users how to:" msgstr "" "理想的には、あなたのパッケージは開発ガイドを持つべきです。 このファイルはあなたのパッケージのドキュメントにあり、 " -"CONTRIBUTING.mdファイル(前述)からリンクされるべきです。 開発ガイドは、技術的に熟達したユーザに対して、以下の方法を明確に示すべきです:" +"CONTRIBUTING.mdファイル(前述)からリンクされるべきです。 " +"開発ガイドは、技術的に熟達したユーザに対して、以下の方法を明確に示すべきです:" -#: ../../documentation/repository-files/development-guide.md:7 +#: ../../documentation/repository-files/development-guide.md:8 msgid "Set up a development environment locally to work on your package" msgstr "開発環境をローカルにセットアップし、パッケージで作業できるようにする" -#: ../../documentation/repository-files/development-guide.md:8 +#: ../../documentation/repository-files/development-guide.md:9 msgid "Run the test suite" msgstr "テストスイートの実行" -#: ../../documentation/repository-files/development-guide.md:9 +#: ../../documentation/repository-files/development-guide.md:10 msgid "Build documentation locally" msgstr "ドキュメントをローカルにビルドする" -#: ../../documentation/repository-files/development-guide.md:11 +#: ../../documentation/repository-files/development-guide.md:12 msgid "The development guide should also have guidelines for:" msgstr "開発ガイドには、次のようなガイドラインもあるはずです:" -#: ../../documentation/repository-files/development-guide.md:12 +#: ../../documentation/repository-files/development-guide.md:14 msgid "" "code standards including docstring style, code format and any specific " "code approaches that the package follows." msgstr "docstringスタイルを含むコード標準、コードフォーマットと、パッケージが従う特定のコードアプローチ。" -#: ../../documentation/repository-files/development-guide.md:14 +#: ../../documentation/repository-files/development-guide.md:16 msgid "" "It's also helpful to specify the types of tests you request if a " "contributor submits a new feature or a change to an existing feature that" " will not be covered by your existing test suite." -msgstr "" -"また、既存のテストスイートではカバーできないような新機能や既存機能の変更をコントリビューターが提出する場合、要求するテストの種類を指定しておくと便利です。" +msgstr "また、既存のテストスイートではカバーできないような新機能や既存機能の変更をコントリビューターが提出する場合、要求するテストの種類を指定しておくと便利です。" -#: ../../documentation/repository-files/development-guide.md:16 +#: ../../documentation/repository-files/development-guide.md:18 msgid "" "If you have time to document it, it's also helpful to document your " "maintainer workflow and release processes." msgstr "もし文書化する時間があれば、メンテナのワークフローやリリースプロセスを文書化することも有用です。" -#: ../../documentation/repository-files/development-guide.md:18 +#: ../../documentation/repository-files/development-guide.md:20 msgid "Why a development guide is important" msgstr "開発ガイドが重要な理由" -#: ../../documentation/repository-files/development-guide.md:20 +#: ../../documentation/repository-files/development-guide.md:22 msgid "It's valuable to have a development guide, in the case that you wish to:" msgstr "開発ガイドを持つことは価値があります、もしそうしたいのであれば:" -#: ../../documentation/repository-files/development-guide.md:23 +#: ../../documentation/repository-files/development-guide.md:25 msgid "Onboard new maintainers." msgstr "新しいメンテナーを迎える。" -#: ../../documentation/repository-files/development-guide.md:24 +#: ../../documentation/repository-files/development-guide.md:26 msgid "" "Allow technically inclined contributors to make thoughtful and useful " "code based pull requests to your repository." msgstr "技術志向のコントリビューターが、あなたのリポジトリに対して、思慮深く有用なコードベースのプルリクエストを行えるようにします。" -#: ../../documentation/repository-files/development-guide.md:26 +#: ../../documentation/repository-files/development-guide.md:28 msgid "" "It also is important to pyOpenSci that the maintenance workflow is " "documented in the case that we need to help you onboard new maintainers " "in the future." -msgstr "" -"また、pyOpenSciにとって、将来新しいメンテナーの参加を支援する必要がある場合に備えて、メンテナンスのワークフローを文書化しておくことも重要です。" +msgstr "また、pyOpenSciにとって、将来新しいメンテナーの参加を支援する必要がある場合に備えて、メンテナンスのワークフローを文書化しておくことも重要です。" -#: ../../documentation/repository-files/development-guide.md:31 +#: ../../documentation/repository-files/development-guide.md:33 msgid "" "A well thought out continuous integration setup in your repository can " "allow users to skip building the package locally (especially if they are " "just updating text)." -msgstr "" -"リポジトリによく考えられた継続的インテグレーションのセットアップがあれば、ユーザーはローカルでのパッケージのビルドを省略することができる（特にテキストを更新するだけの場合）。" +msgstr "リポジトリによく考えられた継続的インテグレーションのセットアップがあれば、ユーザーはローカルでのパッケージのビルドを省略することができる（特にテキストを更新するだけの場合）。" -#: ../../documentation/repository-files/development-guide.md:36 +#: ../../documentation/repository-files/development-guide.md:38 msgid "" "A development guide, while strongly recommended, is not a file that " "pyOpenSci requires a package to have in order to be eligible for review. " "Some maintainers may also opt to include the development information in " "their contributing guide." -msgstr "" -"開発ガイドは強く推奨されますが、pyOpenSciがレビューの対象とするためにパッケージに要求するファイルではありません。メンテナによっては、コントリビューティングガイドに開発情報を含めることもできます。" +msgstr "開発ガイドは強く推奨されますが、pyOpenSciがレビューの対象とするためにパッケージに要求するファイルではありません。メンテナによっては、コントリビューティングガイドに開発情報を含めることもできます。" -#: ../../documentation/repository-files/development-guide.md:43 +#: ../../documentation/repository-files/development-guide.md:44 msgid "" "[The Mozilla Science Lab website has a nice outline of things to consider" " when creating a contributing guide](https://mozillascience.github.io" "/working-open-workshop/contributing/)" msgstr "" "[Mozilla Science " -"Labのウェブサイトには、寄稿ガイドを作成する際に考慮すべきことの素晴らしいアウトラインがあります](https://mozillascience.github.io/working-" -"open-workshop/contributing/)" +"Labのウェブサイトには、寄稿ガイドを作成する際に考慮すべきことの素晴らしいアウトラインがあります](https://mozillascience.github.io" +"/working-open-workshop/contributing/)" #: ../../documentation/repository-files/intro.md:1 msgid "Documentation Files That Should be in your Python Package Repository" @@ -1321,14 +1466,15 @@ msgid "" " that you should have in your Python package repository. Your Python " "package should, at a minimum have the following files:" msgstr "" -"Python パッケージングガイドのこのセクションでは、Python パッケージリポジトリにあるべきすべてのファイルをレビューします。 Python " -"パッケージには最低限以下のファイルが必要です:" +"Python パッケージングガイドのこのセクションでは、Python パッケージリポジトリにあるべきすべてのファイルをレビューします。 " +"Python パッケージには最低限以下のファイルが必要です:" #: ../../documentation/repository-files/intro.md:7 +#, fuzzy msgid "" "The files mentions above (README, Code of Conduct, license file, etc) are" " used as a measure of package community health on many online platforms. " -"Below, you can see an example how Github evaluates community health. This" +"Below, you can see an example how GitHub evaluates community health. This" " community health link is available for all GitHub repositories." msgstr "" "上で言及したファイル（README、行動規範、ライセンスファイルなど）は、多くのオンラインプラットフォームでパッケージコミュニティの健全性を測る尺度として使われています。" @@ -1360,10 +1506,11 @@ msgstr "" "*(2022年11月23日撮影のスクリーンショット)* からのものです。" #: ../../documentation/repository-files/intro.md:22 +#, fuzzy msgid "" "[Snyk](https://snyk.io/advisor/python) is another well-known company that" " keeps tabs on package health. Below you can see a similar evaluation of " -"files in the Github repo as a measure of community health." +"files in the GitHub repo as a measure of community health." msgstr "" "[Snyk](https://snyk.io/advisor/python) もパッケージの健全性を監視している有名な会社です。 " "以下では、コミュニティの健全性を測る尺度として、Github リポジトリ内のファイルに対する同様の評価を見ることができます。" @@ -1376,8 +1523,8 @@ msgid "" "score is 78/100." msgstr "" "movingpandasのSnykページのスクリーンショットです。 " -"このリポジトリには、READMEファイル、貢献ファイル、行動規範があることがわかります。 また、30人の貢献者がいて、資金提供はないことがわかります。 " -"パッケージのヘルススコアは78/100です。" +"このリポジトリには、READMEファイル、貢献ファイル、行動規範があることがわかります。 " +"また、30人の貢献者がいて、資金提供はないことがわかります。 パッケージのヘルススコアは78/100です。" #: ../../documentation/repository-files/intro.md:32 msgid "" @@ -1385,37 +1532,37 @@ msgid "" "package health for moving pandas. Notice both platforms look for a README" " file. *(screen shot taken Nov 23 2022)*" msgstr "" -"[SNYK](https://snyk.io/advisor/python/movingpandas) パッケージの健全性を示すスクリーンショット。 " -"両方のプラットフォームがREADMEファイルを探していることに注目してください。 *(スクリーンショットは2022年11月23日撮影)* 。" +"[SNYK](https://snyk.io/advisor/python/movingpandas) " +"パッケージの健全性を示すスクリーンショット。 両方のプラットフォームがREADMEファイルを探していることに注目してください。 " +"*(スクリーンショットは2022年11月23日撮影)* 。" -#: ../../documentation/repository-files/license-files.md:1 +#: ../../documentation/repository-files/license-files.md:8 msgid "License files for scientific Python open source software" msgstr "科学的Pythonオープンソースソフトウェアのライセンスファイル" -#: ../../documentation/repository-files/license-files.md:3 +#: ../../documentation/repository-files/license-files.md:10 msgid "" "Want to learn how to add a license file to your GitHub repository? Check " "out this lesson." msgstr "" -#: ../../documentation/repository-files/license-files.md:10 +#: ../../documentation/repository-files/license-files.md:17 msgid "What is a Open Source License file?" msgstr "オープンソースライセンスファイルとは何ですか？" -#: ../../documentation/repository-files/license-files.md:12 +#: ../../documentation/repository-files/license-files.md:19 msgid "" "When we talk about LICENSE files, we are referring to a file in your " "GitHub or GitLab repository that contains legally binding language that " "describes to your users how they can legally use (and not use) your " "package." -msgstr "" -"LICENSEファイルというのは、GitHubやGitLabのリポジトリにあるファイルのことです。このファイルには、あなたのパッケージをユーザーが合法的に使う（あるいは使わない）方法が書かれています。" +msgstr "LICENSEファイルというのは、GitHubやGitLabのリポジトリにあるファイルのことです。このファイルには、あなたのパッケージをユーザーが合法的に使う（あるいは使わない）方法が書かれています。" -#: ../../documentation/repository-files/license-files.md:16 +#: ../../documentation/repository-files/license-files.md:23 msgid "Why licenses are important" msgstr "ライセンスが重要な理由" -#: ../../documentation/repository-files/license-files.md:18 +#: ../../documentation/repository-files/license-files.md:25 msgid "" "A license file is important for all open source projects because it " "protects both you as a maintainer and your users. The license file helps " @@ -1424,43 +1571,43 @@ msgstr "" "ライセンスファイルは、メンテナであるあなたとユーザの両方を保護するため、すべてのオープンソースプロジェクトにとって重要です。 " "ライセンスファイルは、あなたのユーザとコミュニティの理解を助けます:" -#: ../../documentation/repository-files/license-files.md:20 +#: ../../documentation/repository-files/license-files.md:27 msgid "How they can use your software" msgstr "ソフトウェアの利用方法" -#: ../../documentation/repository-files/license-files.md:21 +#: ../../documentation/repository-files/license-files.md:28 msgid "Whether the software can be reused or adapted for other purposes" msgstr "ソフトウェアの再利用や他の目的への転用が可能かどうか" -#: ../../documentation/repository-files/license-files.md:22 +#: ../../documentation/repository-files/license-files.md:29 msgid "How people can contribute to your project" msgstr "プロジェクトに貢献する方法" -#: ../../documentation/repository-files/license-files.md:24 +#: ../../documentation/repository-files/license-files.md:31 msgid "and more." msgstr "などなど。" -#: ../../documentation/repository-files/license-files.md:26 +#: ../../documentation/repository-files/license-files.md:33 msgid "" "[Read more about why license files are critical in protecting both you as" " a maintainer and your users of your scientific Python open source " "package.](https://opensource.guide/legal/#just-give-me-the-tldr-on-what-i" "-need-to-protect-my-project)" msgstr "" -"[科学的なPythonオープンソースパッケージのメンテナであるあなたとユーザの両方を保護するために、ライセンスファイルが重要である理由についてもっと読む](https://opensource.guide/legal/#just-" -"give-me-the-tldr-on-what-i-need-to-protect-my-project)" +"[科学的なPythonオープンソースパッケージのメンテナであるあなたとユーザの両方を保護するために、ライセンスファイルが重要である理由についてもっと読む](https://opensource.guide/legal" +"/#just-give-me-the-tldr-on-what-i-need-to-protect-my-project)" -#: ../../documentation/repository-files/license-files.md:29 +#: ../../documentation/repository-files/license-files.md:35 msgid "Where to store your license" msgstr "ライセンスの保管場所" -#: ../../documentation/repository-files/license-files.md:31 +#: ../../documentation/repository-files/license-files.md:37 msgid "" "Your `LICENSE` file should be stored at root of your GitHub / GitLab " "repository." msgstr "`LICENSE` ファイルは GitHub / GitLab リポジトリのルートに保存してください。" -#: ../../documentation/repository-files/license-files.md:33 +#: ../../documentation/repository-files/license-files.md:39 msgid "" "Some maintainers customize the language in their license files for " "specific reasons. However, if you are just getting started, we suggest " @@ -1468,21 +1615,22 @@ msgid "" "templates provided both by GitHub and/or the " "[choosealicense.com](https://choosealicense.com/) website." msgstr "" -"特定の理由からライセンスファイルの言葉をカスタマイズするメンテナもいます。 しかし、これから始めるのであれば、寛容なライセンスを選択し、GitHubや " +"特定の理由からライセンスファイルの言葉をカスタマイズするメンテナもいます。 " +"しかし、これから始めるのであれば、寛容なライセンスを選択し、GitHubや " "[choosealicense.com](https://choosealicense.com/) " "のウェブサイトで提供されている法的な言語テンプレートを使うことをお勧めします。" -#: ../../documentation/repository-files/license-files.md:36 +#: ../../documentation/repository-files/license-files.md:42 msgid "" "Licenses are legally binding, as such you should avoid trying to create " "your own license unless you have the guidance of legal council." msgstr "ライセンスには法的拘束力があるため、法律顧問の指導がない限り、独自のライセンスを作成しようとするのは避けるべきです。" -#: ../../documentation/repository-files/license-files.md:38 +#: ../../documentation/repository-files/license-files.md:44 msgid "Use open permissive licenses when possible" msgstr "可能な限りオープンパーミッシブライセンスを使用する" -#: ../../documentation/repository-files/license-files.md:40 +#: ../../documentation/repository-files/license-files.md:46 msgid "" "We generally suggest that you use a permissive, license that is [Open " "Software Initiative (OSI) approved](https://opensource.org/licenses/). If" @@ -1495,132 +1643,233 @@ msgstr "" "もしあなたが[査読のためにpyOpenSciにパッケージを提出する](https://www.pyopensci.org/about-peer-" "review/index.html) のであれば、OSIが承認したライセンスが必要です。" -#: ../../documentation/repository-files/license-files.md:44 +#: ../../documentation/repository-files/license-files.md:50 +msgid "Copyleft licenses" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:51 +msgid "" +"The other major category of licenses are [\"copyleft\" " +"licenses](https://en.wikipedia.org/wiki/Copyleft). Copyleft licenses " +"require people that use your work to redistribute it with the same (or " +"greater) rights to modify, copy, share, and redistribute it. In other " +"words, copyleft licenses prohibit someone taking your work, making a " +"proprietary version of it, and redistributing it without providing the " +"source code so others can do the same. Copyleft licenses are \"sticky\" " +"in that they are designed to ensure that more free software is created." +msgstr "" + +#: ../../documentation/repository-files/license-files.md:56 +#, python-brace-format +msgid "" +"The difference between copyleft and permissive licenses is an important " +"cultural divide in free and open source software (e.g., see " +"{footcite}`hunterReclaimingComputingCommons2016`, " +"{footcite}`gnuprojectWhatFreeSoftware2019`, " +"{footcite}`gnuprojectWhatCopyleft2022`). It is important to understand " +"this difference when choosing your license. Copyleft licenses represents " +"the \"free\" part of \"free and open source software\". Free and open " +"source software is intrinsically political, and it is important to be " +"aware of power dynamics in computing as well as the practical problems of" +" license compatibility (discussed below)." +msgstr "" + +#: ../../documentation/repository-files/license-files.md:61 msgid "How to choose a license" msgstr "ライセンスの選び方" -#: ../../documentation/repository-files/license-files.md:46 +#: ../../documentation/repository-files/license-files.md:63 +#, fuzzy msgid "" "To select your license, we suggest that you use GitHub's [Choose a " -"License tool ](https://choosealicense.com/)." +"License tool](https://choosealicense.com/)." msgstr "" -"ライセンスを選択するには、GitHubの [Choose a License tool](https://choosealicense.com/) " -"を使うことをお勧めします。" +"ライセンスを選択するには、GitHubの [Choose a License tool](https://choosealicense.com/)" +" を使うことをお勧めします。" -#: ../../documentation/repository-files/license-files.md:49 +#: ../../documentation/repository-files/license-files.md:66 msgid "" "If you choose your license when creating a new GitHub repository, you can" " also automatically get a text copy of the license file to add to your " "repository. However in some cases the license that you want is not " "available through that online process." msgstr "" -"GitHub リポジトリの新規作成時にライセンスを選択すると、自動的にライセンスファイルのテキストコピーを取得してリポジトリに追加することもできます。 " +"GitHub " +"リポジトリの新規作成時にライセンスを選択すると、自動的にライセンスファイルのテキストコピーを取得してリポジトリに追加することもできます。 " "しかし、オンラインプロセスでは希望のライセンスが取得できないこともあります。" -#: ../../documentation/repository-files/license-files.md:54 +#: ../../documentation/repository-files/license-files.md:71 msgid "License recommendations from the SciPy package" msgstr "SciPyパッケージからのライセンス勧告" -#: ../../documentation/repository-files/license-files.md:55 +#: ../../documentation/repository-files/license-files.md:72 +#, fuzzy msgid "" "[The SciPy documentation has an excellent overview of " "licenses.](https://docs.scipy.org/doc/scipy/dev/core-" -"dev/index.html#licensing). Once of the key elements that these docs " -"recommend is ensuring that the license that you select is complementary " -"to license used in the core scientific Python ecosystem. Below is a " -"highlight of this text which outlines license that are compatible with " -"the modified BSD license that SciPy uses." -msgstr "" -"[SciPyのドキュメントには、ライセンスの優れた概要があります](https://docs.scipy.org/doc/scipy/dev/core-" -"dev/index.html#licensing) 。 " +"dev/index.html#licensing). One of the key elements that these docs " +"recommend is ensuring that the license that you select is compatible with" +" licenses used in many parts of the scientific Python ecosystem. Below is" +" a highlight of this text which outlines license that are compatible with" +" the modified BSD license that SciPy uses." +msgstr "" +"[SciPyのドキュメントには、ライセンスの優れた概要があります](https://docs.scipy.org/doc/scipy/dev" +"/core-dev/index.html#licensing) 。 " "これらのドキュメントが推奨する重要な要素の一つは、選択するライセンスが科学的なPythonのエコシステムのコアで使用されているライセンスと相補的であることを確認することです。" " 以下は、SciPyが使用している修正BSDライセンスと互換性のあるライセンスの概要です。" -#: ../../documentation/repository-files/license-files.md:61 +#: ../../documentation/repository-files/license-files.md:78 msgid "" "Other licenses that are compatible with the modified BSD license that " "SciPy uses are 2-clause BSD, MIT and PSF. Incompatible licenses are GPL, " "Apache and custom licenses that require attribution/citation or prohibit " "use for commercial purposes." msgstr "" -"SciPyが使用している修正BSDライセンスと互換性のある他のライセンスは、2-clause BSD、MIT、PSFです。 " -"Licenses are legally binding, as such you should avoid trying to create " -"your own license unless you have the guidance of legal council." -"互換性のないライセンスは、GPL、Apache、および帰属表示/引用を必要とする、または商用目的での使用を禁止するカスタムライセンスです。" +"SciPyが使用している修正BSDライセンスと互換性のある他のライセンスは、2-clause BSD、MIT、PSFです。 Licenses " +"are legally binding, as such you should avoid trying to create your own " +"license unless you have the guidance of legal " +"council.互換性のないライセンスは、GPL、Apache、および帰属表示/引用を必要とする、または商用目的での使用を禁止するカスタムライセンスです。" -#: ../../documentation/repository-files/license-files.md:63 +#: ../../documentation/repository-files/license-files.md:80 +#, fuzzy msgid "" -"To coordinate with other packages in our scientific ecosystem, we also " -"recommend that you consider using either BSD or MIT as your license. If " -"you are unsure, the MIT license tends to be a simpler easier-to-" -"understand option." +"If your primary goal is for your code to be used by other, major packages" +" in the scientific ecosystem, we also recommend that you consider using " +"either BSD or MIT as your license. If you are unsure, the MIT license " +"tends to be a simpler easier-to-understand option." msgstr "" "わたしたちの科学的エコシステムの他のパッケージと協調するために、BSDかMITのどちらかのライセンスを使うことを検討することも推奨します。 " "よくわからない場合、MITライセンスはよりシンプルで理解しやすい選択肢となる傾向があります。" -#: ../../documentation/repository-files/license-files.md:69 +#: ../../documentation/repository-files/license-files.md:85 msgid "" "Important: make sure that you closely follow the guidelines outlines by " "the License that you chose" msgstr "重要：選択したライセンスのガイドラインに忠実に従うこと" -#: ../../documentation/repository-files/license-files.md:71 +#: ../../documentation/repository-files/license-files.md:87 msgid "" "Every license has different guidelines in terms of what code you can use " "in your package and also how others can (or can not) use the code in your" " package." -msgstr "" -"どのライセンスも、あなたがパッケージの中でどのようなコードを使うことができるか、また、他の人があなたのパッケージの中のコードをどのように使うことができるか(あるいは使うことができないか)という点で、異なるガイドラインを持っています。" +msgstr "どのライセンスも、あなたがパッケージの中でどのようなコードを使うことができるか、また、他の人があなたのパッケージの中のコードをどのように使うことができるか(あるいは使うことができないか)という点で、異なるガイドラインを持っています。" -#: ../../documentation/repository-files/license-files.md:74 +#: ../../documentation/repository-files/license-files.md:90 msgid "" "If you borrow code from other tools or online sources, make sure that the" " license for the code that you are using also complies with the license " "that you selected for your package." +msgstr "他のツールやオンラインソースからコードを借用する場合は、使用するコードのライセンスが、あなたがパッケージに選択したライセンスにも準拠していることを確認してください。" + +#: ../../documentation/repository-files/license-files.md:94 +msgid "" +"A useful way to think about license compatibility is the distinction " +"between **\"inbound\"** and **\"outbound\"** compatibility. \"Inbound\" " +"licenses are those that cover the software you plan to include in your " +"package. Your package is protected by an \"outbound\" license." msgstr "" -"他のツールやオンラインソースからコードを借用する場合は、使用するコードのライセンスが、あなたがパッケージに選択したライセンスにも準拠していることを確認してください。" -#: ../../documentation/repository-files/license-files.md:78 +#: ../../documentation/repository-files/license-files.md:98 +msgid "" +"**Permissive licenses** like BSD and MIT have few **outbound** " +"restrictions - they can be used in any way by downstream consumers, " +"including making them proprietary. This is why they are favored by many " +"businesses and large packages that want to be adopted by businesses. " +"Permissive licenses have more **inbound** restrictions - they can't use " +"software that requires more freedoms to be preserved than they do, like " +"copyleft licenses. A package licensed under MIT needs to take special " +"care when including or modifying a package licensed under the GPL-3." +msgstr "" + +#: ../../documentation/repository-files/license-files.md:103 +msgid "" +"**Copyleft licenses** like GPL-3 have more **outbound** restrictions - " +"they require more of packages that include, use, modify, and reproduce " +"them. This is the purpose of copyleft licenses, to ensure that derivative" +" works remain free and open source. They have fewer **inbound** " +"restrictions - a GPL-3 licensed package can include any other " +"permissively licensed and most copyleft licensed packages." +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "Compatible" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "Dependency
(\"Inbound\")" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +#, fuzzy +msgid "Your Package" +msgstr "✔️ パッケージ名" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "Downstream Package
(\"Outbound\")" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "Permissive" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:71 +msgid "Copyleft" +msgstr "" + +#: ../../documentation/repository-files/license-files.md:118 msgid "An example of how a license determine how code can be reused" msgstr "ライセンスがコードの再利用を決定する例" -#: ../../documentation/repository-files/license-files.md:81 +#: ../../documentation/repository-files/license-files.md:121 msgid "" "Let's use StackOverflow as an example that highlights how a license " "determines how code can or can not be used." msgstr "StackOverflowを例に、ライセンスによってコードの使用可否がどのように決まるかを明らかにしましょう。" -#: ../../documentation/repository-files/license-files.md:83 +#: ../../documentation/repository-files/license-files.md:123 +#, fuzzy msgid "" -"[Stack overflow uses a Creative Commons Share Alike " +"[Stack Overflow uses a Creative Commons Share Alike " "license.](https://stackoverflow.com/help/licensing). The sharealike " "license requires you to use the same sharealike license when you reuse " -"any code from StackOverflow." +"any code from Stack Overflow." msgstr "" "[Stack overflowはCreative Commons Share " "Alikeライセンスを使用しています。](https://stackoverflow.com/help/licensing) " "Sharealikeライセンスでは、StackOverflowのコードを再利用する際に、同じSharealikeライセンスを使用することが義務付けられています。" -#: ../../documentation/repository-files/license-files.md:85 +#: ../../documentation/repository-files/license-files.md:125 +#, fuzzy, python-brace-format msgid "" -"This means that technically, if you copy code from the Stack Overflow " -"website, and use it in your package. And your packages uses a different " -"license such as a MIT license, you are violating Stack Overflow's license" -" requirements!" +"This means that from a legal perspective, if you copy code from the Stack" +" Overflow website and use it in your package that is licensed " +"differently, say with a MIT license, you are violating Stack Overflow's " +"license requirements! This would not be true with a GPL licensed package." +" `GPL-3` packages can include code licensed by `CC-BY-SA` " +"{footcite}`creativecommonsShareAlikeCompatibilityGPLv32015`." msgstr "" "つまり、技術的には、Stack Overflowのウェブサイトからコードをコピーし、それをあなたのパッケージで使用する場合です。 " "そして、あなたのパッケージがMITライセンスのような異なるライセンスを使用している場合、あなたはStack " "Overflowのライセンス要件に違反していることになります！" -#: ../../documentation/repository-files/license-files.md:87 +#: ../../documentation/repository-files/license-files.md:128 msgid "🚨 Proceed with caution! 🚨" msgstr "🚨 慎重に進め！ 🚨" -#: ../../documentation/repository-files/license-files.md:91 +#: ../../documentation/repository-files/license-files.md:131 msgid "What about software citation?" msgstr "ソフトウェアの引用についてはどうだろうか？" -#: ../../documentation/repository-files/license-files.md:93 +#: ../../documentation/repository-files/license-files.md:133 +#, fuzzy msgid "" "While many permissive licenses do not require citation we STRONG " "encourage that you cite all software that you use in papers, blogs and " @@ -1628,19 +1877,24 @@ msgid "" " a [citation.cff file](https://docs.github.com/en/repositories/managing-" "your-repositorys-settings-and-features/customizing-your-repository/about-" "citation-files). We will cover this topic when we talk about creating " -"DOI's for your package using zenodo." +"DOI's for your package using Zenodo." msgstr "" "多くの寛容なライセンスは引用を必要としませんが、わたしたちは、あなたが論文やブログ、その他の出版物で使用するすべてのソフトウェアを引用することを強く推奨します。" -" あなたは、 [citation.cff ファイル](https://docs.github.com/en/repositories/managing-" -"your-repositorys-settings-and-features/customizing-your-repository/about-" -"citation-files) を使うことで、あなたのパッケージの引用方法をユーザに伝えることができます。 " +" あなたは、 [citation.cff ファイル](https://docs.github.com/en/repositories" +"/managing-your-repositorys-settings-and-features/customizing-your-" +"repository/about-citation-files) を使うことで、あなたのパッケージの引用方法をユーザに伝えることができます。 " "このトピックについては、zenodoを使ってパッケージのDOIを作成する際に説明します。" -#: ../../documentation/repository-files/readme-file-best-practices.md:1 +#: ../../documentation/repository-files/license-files.md:141 +#, fuzzy +msgid "References" +msgstr "READMEリソース" + +#: ../../documentation/repository-files/readme-file-best-practices.md:3 msgid "README File Guidelines and Resources" msgstr "READMEファイルのガイドラインとリソース" -#: ../../documentation/repository-files/readme-file-best-practices.md:3 +#: ../../documentation/repository-files/readme-file-best-practices.md:5 msgid "" "Your **README.md** file should be located in the root of your GitHub " "repository. The **README.md** file is important as it is often the first " @@ -1649,39 +1903,40 @@ msgstr "" "**README.md** ファイルは、GitHubリポジトリのルートに置く必要があります。 **README.md** " "ファイルは、あなたのパッケージをインストールする前に誰かが最初に目にすることが多いので重要です。" -#: ../../documentation/repository-files/readme-file-best-practices.md:7 +#: ../../documentation/repository-files/readme-file-best-practices.md:9 msgid "The README.md file is the landing page of:" msgstr "README.mdファイルは、そのランディングページです:" -#: ../../documentation/repository-files/readme-file-best-practices.md:9 +#: ../../documentation/repository-files/readme-file-best-practices.md:11 msgid "" "Your package as it appears on a repository site such as PyPI or " "Anaconda.org" msgstr "PyPIやAnaconda.orgのようなリポジトリサイトに表示されているあなたのパッケージ" -#: ../../documentation/repository-files/readme-file-best-practices.md:10 +#: ../../documentation/repository-files/readme-file-best-practices.md:12 msgid "Your package's GitHub repository" msgstr "あなたのパッケージのGitHubリポジトリ" -#: ../../documentation/repository-files/readme-file-best-practices.md:12 +#: ../../documentation/repository-files/readme-file-best-practices.md:14 msgid "" "Your README.md file is also used as a measure of package and community " "health on sites such as:" msgstr "あなたのREADME.mdファイルは、以下のようなサイトで、パッケージやコミュニティの健全性の指標としても使われています:" -#: ../../documentation/repository-files/readme-file-best-practices.md:14 +#: ../../documentation/repository-files/readme-file-best-practices.md:17 +#, fuzzy msgid "" "[GitHub community health for MovingPandas (available for all " -"repositories)](https://github.com/anitagraser/movingpandas/community) and" -" [Snyk - moving pandas " +"repositories)](https://github.com/movingpandas/movingpandas/community) " +"and [Snyk - MovingPandas " "example](https://snyk.io/advisor/python/movingpandas)" msgstr "" "[GitHub community health for MovingPandas (available for all " "repositories)](https://github.com/anitagraser/movingpandas/community) と " -"[Snyk - moving pandas example](https://snyk.io/advisor/python/movingpandas) " -"。" +"[Snyk - moving pandas " +"example](https://snyk.io/advisor/python/movingpandas) 。" -#: ../../documentation/repository-files/readme-file-best-practices.md:17 +#: ../../documentation/repository-files/readme-file-best-practices.md:19 msgid "" "README landing page screenshot for the Pandera package. It has the " "Pandera logo at the top - which has two arrows in a chevron pattern " @@ -1698,7 +1953,7 @@ msgstr "" " " "PanderaパッケージのREADMEランディングページのスクリーンショット。上部にPanderaのロゴがあり、丸の中にシェブロン模様の2本の矢印が下を向いています。副題は統計データテストツールキットです。正しさを追求する科学者、エンジニアリング、アナリティクスのためのデータ検証ライブラリです。その下には、CIテスト合格、ドキュメント合格、pypi上のPanderaのバージョン(0.13.4)、MITライセンス、pyOpenSci査読済みなどのバッジがあります。その下にも数多くのバッジがあります。バッジの下には、Panderaは、データ処理パイプラインの可読性と堅牢性を向上させるために、データフレームのようなオブジェクトに対してデータ検証を実行するための柔軟で表現力豊かなAPIを提供しますとあります。" -#: ../../documentation/repository-files/readme-file-best-practices.md:23 +#: ../../documentation/repository-files/readme-file-best-practices.md:25 msgid "" "Your GitHub repository landing page highlights the README.md file. Here " "you can see the README.md file for the pyOpenSci package " @@ -1706,52 +1961,52 @@ msgid "" "Nov 23 2022)*" msgstr "" "GitHub リポジトリのランディングページは README.md ファイルをハイライトします。ここでは、pyOpenSciパッケージ " -"[Pandera](https://github.com/unionai-oss/pandera) のREADME.mdファイルを見ることができます。 " -"*(スクリーンショットは2022年11月23日撮影)* 。" +"[Pandera](https://github.com/unionai-oss/pandera) " +"のREADME.mdファイルを見ることができます。 *(スクリーンショットは2022年11月23日撮影)* 。" -#: ../../documentation/repository-files/readme-file-best-practices.md:26 +#: ../../documentation/repository-files/readme-file-best-practices.md:28 msgid "" "Thus, it is important that you spend some time up front creating a high " "quality **README.md** file for your Python package." msgstr "従って、Pythonパッケージのために高品質の **README.md** ファイルを作成するために、前もって時間をかけることが重要です。" -#: ../../documentation/repository-files/readme-file-best-practices.md:30 +#: ../../documentation/repository-files/readme-file-best-practices.md:32 msgid "" "An editor or the editor in chief will ask you to revise your README file " "before a review begins if it does not meet the criteria specified below." msgstr "READMEファイルが以下に指定された基準を満たしていない場合、編集者または編集長はレビュー開始前に修正を依頼します。" -#: ../../documentation/repository-files/readme-file-best-practices.md:33 +#: ../../documentation/repository-files/readme-file-best-practices.md:35 msgid "Please go through this list before submitting your package to pyOpenSci" msgstr "あなたのパッケージをpyOpenSciに投稿する前に、このリストに目を通してください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:50 +#: ../../documentation/repository-files/readme-file-best-practices.md:52 msgid "What your README.md file should contain" msgstr "README.mdファイルの内容" -#: ../../documentation/repository-files/readme-file-best-practices.md:52 +#: ../../documentation/repository-files/readme-file-best-practices.md:54 msgid "" "Your **README.md** file should contain the following things (listed from " "top to bottom):" msgstr "**README.md** ファイルには、（上から順番に）以下のことが書かれているはずです：" -#: ../../documentation/repository-files/readme-file-best-practices.md:54 +#: ../../documentation/repository-files/readme-file-best-practices.md:56 msgid "✔️ Your package's name" msgstr "✔️ パッケージ名" -#: ../../documentation/repository-files/readme-file-best-practices.md:55 +#: ../../documentation/repository-files/readme-file-best-practices.md:58 msgid "" "Ideally your GitHub repository's name is also the name of your package. " "The more self explanatory that name is, the better." msgstr "GitHub リポジトリの名前がパッケージの名前にもなっているのが理想的です。 説明しやすい名前であればあるほどよいでしょう。" -#: ../../documentation/repository-files/readme-file-best-practices.md:58 +#: ../../documentation/repository-files/readme-file-best-practices.md:61 msgid "" "✔️ Badges for current package version, continuous integration and test " "coverage" msgstr "✔️ 現在のパッケージバージョン、継続的インテグレーション、テストカバレッジのバッジ" -#: ../../documentation/repository-files/readme-file-best-practices.md:60 +#: ../../documentation/repository-files/readme-file-best-practices.md:63 msgid "" "Badges are a useful way to draw attention to the quality of your project." " Badges assure users that your package is well-designed, tested, and " @@ -1762,25 +2017,25 @@ msgid "" msgstr "" "バッジは、あなたのプロジェクトの品質に注意を向けるための便利な方法です。 " "バッジは、あなたのパッケージがよく設計され、テストされ、保守されていることをユーザに保証します。 " -"また、適切にビルドされているかどうかを評価するのに便利なメンテナンスツールでもあります。 README.mdファイルに [Read the Docs " -"status badge](https://docs.readthedocs.io/en/stable/badges.html) " +"また、適切にビルドされているかどうかを評価するのに便利なメンテナンスツールでもあります。 README.mdファイルに [Read the " +"Docs status badge](https://docs.readthedocs.io/en/stable/badges.html) " "を追加することで、そのサイトのビルドが失敗したときにすぐに確認することができます。" -#: ../../documentation/repository-files/readme-file-best-practices.md:66 +#: ../../documentation/repository-files/readme-file-best-practices.md:69 msgid "" "It is common to provide a collection of badges towards the top of your " "README file for others to quickly browse." msgstr "READMEファイルの一番上に、他の人がすぐに閲覧できるようにバッジのコレクションを提供するのが一般的です。" -#: ../../documentation/repository-files/readme-file-best-practices.md:69 +#: ../../documentation/repository-files/readme-file-best-practices.md:72 msgid "Some badges that you might consider adding to your README file include:" msgstr "READMEファイルへの追加を検討すべきバッジには、以下のようなものがあります:" -#: ../../documentation/repository-files/readme-file-best-practices.md:71 +#: ../../documentation/repository-files/readme-file-best-practices.md:74 msgid "Current version of the package on PyPI / Anaconda.org" msgstr "PyPI / Anaconda.org にあるパッケージの最新バージョン" -#: ../../documentation/repository-files/readme-file-best-practices.md:73 +#: ../../documentation/repository-files/readme-file-best-practices.md:76 msgid "" "Example: [![PyPI version " "shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)" @@ -1788,11 +2043,11 @@ msgstr "" "例: [![PyPI version " "shields.io](https://img.shields.io/pypi/v/pandera.svg)](https://pypi.org/project/pandera/)" -#: ../../documentation/repository-files/readme-file-best-practices.md:73 +#: ../../documentation/repository-files/readme-file-best-practices.md:76 msgid "PyPI version shields.io" msgstr "PyPIバージョン shields.io" -#: ../../documentation/repository-files/readme-file-best-practices.md:75 +#: ../../documentation/repository-files/readme-file-best-practices.md:78 msgid "" "Status of tests (pass or fail) - Example: [![CI Build](https://github.com" "/pandera-" @@ -1801,14 +2056,15 @@ msgid "" "dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain)" msgstr "" "テストのステータス(合格または不合格) - 例: [![CI Build](https://github.com/pandera-" -"dev/pandera/workflows/CI%20Tests/badge.svg?branch=main)](https://github.com/pandera-" +"dev/pandera/workflows/CI%20Tests/badge.svg?branch=main)](https://github.com" +"/pandera-" "dev/pandera/actions?query=workflow%3A%22CI+Tests%22+branch%3Amain)" -#: ../../documentation/repository-files/readme-file-best-practices.md:75 +#: ../../documentation/repository-files/readme-file-best-practices.md:78 msgid "CI Build" msgstr "CI ビルド" -#: ../../documentation/repository-files/readme-file-best-practices.md:77 +#: ../../documentation/repository-files/readme-file-best-practices.md:80 msgid "" "Documentation build - Example: ![Docs " "Building](https://github.com/pyOpenSci/python-package-" @@ -1817,11 +2073,11 @@ msgstr "" "ドキュメントのビルド - 例: ![Docs Building](https://github.com/pyOpenSci/python-" "package-guide/actions/workflows/build-book.yml/badge.svg)" -#: ../../documentation/repository-files/readme-file-best-practices.md:77 +#: ../../documentation/repository-files/readme-file-best-practices.md:80 msgid "Docs Building" msgstr "ドキュメントビルディング" -#: ../../documentation/repository-files/readme-file-best-practices.md:79 +#: ../../documentation/repository-files/readme-file-best-practices.md:82 msgid "" "DOI (for citation) Example: " "[![DOI](https://zenodo.org/badge/556814582.svg)](https://zenodo.org/badge/latestdoi/556814582)" @@ -1829,11 +2085,11 @@ msgstr "" "(参照のための) DOI の例: " "[![DOI](https://zenodo.org/badge/556814582.svg)](https://zenodo.org/badge/latestdoi/556814582)" -#: ../../documentation/repository-files/readme-file-best-practices.md:79 +#: ../../documentation/repository-files/readme-file-best-practices.md:82 msgid "DOI" msgstr "DOI" -#: ../../documentation/repository-files/readme-file-best-practices.md:82 +#: ../../documentation/repository-files/readme-file-best-practices.md:85 msgid "" "Once you package is accepted to pyOpenSci, we will provide you with a " "badge to add to your repository that shows that it has been reviewed. " @@ -1844,21 +2100,21 @@ msgstr "" "[![pyOpenSci](https://pyopensci.org/badges/peer-" "reviewed.svg)](https://github.com/pyOpenSci/software-review/issues/12)" -#: ../../documentation/repository-files/readme-file-best-practices.md:82 +#: ../../documentation/repository-files/readme-file-best-practices.md:85 msgid "pyOpenSci" msgstr "pyOpenSci" -#: ../../documentation/repository-files/readme-file-best-practices.md:90 +#: ../../documentation/repository-files/readme-file-best-practices.md:92 msgid "" "Beware of the overuse of badges! There is such a thing as too much of a " "good thing (which can overload a potential user!)." msgstr "バッジの使い過ぎに注意！ 過ぎたるは及ばざるが如し(潜在的なユーザーを過負荷にする可能性があります!)。" -#: ../../documentation/repository-files/readme-file-best-practices.md:93 +#: ../../documentation/repository-files/readme-file-best-practices.md:95 msgid "✔️ A short, easy-to-understand description of what your package does" msgstr "✔️ あなたのパッケージが何をするのかを短く、わかりやすく説明する。" -#: ../../documentation/repository-files/readme-file-best-practices.md:95 +#: ../../documentation/repository-files/readme-file-best-practices.md:97 msgid "" "At the top of your README file you should have a short, easy-to-" "understand, 1-3 sentence description of what your package does. This " @@ -1866,10 +2122,9 @@ msgid "" "this description should use less technical terms so that a variety of " "users with varying scientific (and development) backgrounds can " "understand it." -msgstr "" -"READMEファイルの一番上に、あなたのパッケージが何をするのか、短く、わかりやすく、1-3文の説明を書くべきです。このセクションには、パッケージの目標を明記します。この説明では、科学的（および開発的）背景が異なるさまざまなユーザーが理解できるように、専門用語をあまり使わないようにすべきです。" +msgstr "READMEファイルの一番上に、あなたのパッケージが何をするのか、短く、わかりやすく、1-3文の説明を書くべきです。このセクションには、パッケージの目標を明記します。この説明では、科学的（および開発的）背景が異なるさまざまなユーザーが理解できるように、専門用語をあまり使わないようにすべきです。" -#: ../../documentation/repository-files/readme-file-best-practices.md:101 +#: ../../documentation/repository-files/readme-file-best-practices.md:103 msgid "" "In this description, it's useful to let users know how your package fits " "within the broader scientific Python package ecosystem. If there are " @@ -1880,7 +2135,7 @@ msgstr "" "パッケージのエコシステムの中でどのように位置づけられるかをユーザに知らせるのに役立ちます。 " "もし他に似たようなパッケージや補完的なパッケージがあれば、ここで1-2文でそれらに言及してください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:106 +#: ../../documentation/repository-files/readme-file-best-practices.md:108 msgid "" "Consider writing for a high school level (or equivalent) level. This " "level of writing is often considered an appropriate level for scientific " @@ -1889,29 +2144,28 @@ msgstr "" "高校レベル（または同等のレベル）の文章を書くことを考慮します。 " "このレベルの文章は、さまざまな背景を持つさまざまなユーザーに役立つ科学的な内容として、しばしば適切なレベルとみなされます。" -#: ../../documentation/repository-files/readme-file-best-practices.md:110 +#: ../../documentation/repository-files/readme-file-best-practices.md:112 msgid "" "The goal of this description is to maximize accessibility of your " "**README** file." msgstr "この記述の目的は、 **README** ファイルへのアクセシビリティを最大化することです。" -#: ../../documentation/repository-files/readme-file-best-practices.md:114 +#: ../../documentation/repository-files/readme-file-best-practices.md:116 msgid "✔️ Installation instructions" msgstr "✔️ インストール手順" -#: ../../documentation/repository-files/readme-file-best-practices.md:116 +#: ../../documentation/repository-files/readme-file-best-practices.md:118 msgid "" "Include instructions for installing your package. If you have published " "the package on both PyPI and Anaconda.org, be sure to include " "instructions for both." -msgstr "" -"パッケージのインストール手順を含めます。 PyPIとAnaconda.orgの両方でパッケージを公開している場合は、必ず両方の説明を含めてください。" +msgstr "パッケージのインストール手順を含めます。 PyPIとAnaconda.orgの両方でパッケージを公開している場合は、必ず両方の説明を含めてください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:119 +#: ../../documentation/repository-files/readme-file-best-practices.md:121 msgid "✔️ Document any additional setup required" msgstr "✔️ 必要な追加設定を文書化する" -#: ../../documentation/repository-files/readme-file-best-practices.md:121 +#: ../../documentation/repository-files/readme-file-best-practices.md:123 msgid "" "Add any additional setup required such as authentication tokens, to get " "started using your package. If setup is complex, consider linking to an " @@ -1921,43 +2175,43 @@ msgstr "" "認証トークンなど、パッケージの使用を開始するために必要な追加設定を追加します。 " "セットアップが複雑な場合は、READMEファイルを複雑にしすぎるのではなく、オンラインドキュメントのインストールページにリンクすることを検討してください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:126 +#: ../../documentation/repository-files/readme-file-best-practices.md:128 msgid "✔️ Brief demonstration of how to use the package" msgstr "✔️ パッケージの使い方の簡単なデモンストレーション" -#: ../../documentation/repository-files/readme-file-best-practices.md:128 +#: ../../documentation/repository-files/readme-file-best-practices.md:130 msgid "" "This description ideally includes a brief, quick start code example that " "shows a user how to get started using your package." msgstr "この説明には、あなたのパッケージを使い始める方法をユーザーに示す、簡単なクイックスタートコードの例が含まれているのが理想的です。" -#: ../../documentation/repository-files/readme-file-best-practices.md:131 +#: ../../documentation/repository-files/readme-file-best-practices.md:133 msgid "✔️ Descriptive links to package documentation, short tutorials" msgstr "✔️ パッケージドキュメントへの説明的なリンク、短いチュートリアル" -#: ../../documentation/repository-files/readme-file-best-practices.md:133 +#: ../../documentation/repository-files/readme-file-best-practices.md:135 msgid "Include descriptive links to:" msgstr "説明的なリンクを含める:" -#: ../../documentation/repository-files/readme-file-best-practices.md:135 +#: ../../documentation/repository-files/readme-file-best-practices.md:137 msgid "The package's documentation page." msgstr "パッケージのドキュメントページ。" -#: ../../documentation/repository-files/readme-file-best-practices.md:136 +#: ../../documentation/repository-files/readme-file-best-practices.md:138 msgid "Short tutorials that demonstrate application of your package." msgstr "パッケージのアプリケーションをデモンストレーションする短いチュートリアル。" -#: ../../documentation/repository-files/readme-file-best-practices.md:138 +#: ../../documentation/repository-files/readme-file-best-practices.md:140 msgid "Too Much Of A Good Thing" msgstr "良いことのあまり" -#: ../../documentation/repository-files/readme-file-best-practices.md:141 +#: ../../documentation/repository-files/readme-file-best-practices.md:143 msgid "" "Try to avoid including several tutorials in the README.md file itself. " "This too will overwhelm the user with information." msgstr "README.mdファイル自体に複数のチュートリアルを含めるのはなるべく避けてください。 これもユーザーを情報で圧倒してしまいます。" -#: ../../documentation/repository-files/readme-file-best-practices.md:143 +#: ../../documentation/repository-files/readme-file-best-practices.md:145 msgid "" "A short quick-start code example that shows someone how to use your " "package is plenty of content for the README file. All other tutorials and" @@ -1966,60 +2220,59 @@ msgstr "" "READMEファイルの内容は、あなたのパッケージの使い方を示す短いクイックスタートのコード例で十分です。 " "他のすべてのチュートリアルやドキュメントは、説明的なリンクとして表示されるべきです。" -#: ../../documentation/repository-files/readme-file-best-practices.md:149 +#: ../../documentation/repository-files/readme-file-best-practices.md:151 msgid "✔️ A Community Section with Links to Contributing Guide, Code of Conduct" msgstr "✔️ 貢献ガイド、行動規範へのリンクがあるコミュニティセクション" -#: ../../documentation/repository-files/readme-file-best-practices.md:151 +#: ../../documentation/repository-files/readme-file-best-practices.md:153 msgid "Use your README.md file to direct users to more information on:" msgstr "README.mdファイルを使用して、ユーザーをより詳細な情報に誘導する:" -#: ../../documentation/repository-files/readme-file-best-practices.md:153 +#: ../../documentation/repository-files/readme-file-best-practices.md:155 msgid "Contributing to your package" msgstr "パッケージへの貢献" -#: ../../documentation/repository-files/readme-file-best-practices.md:154 +#: ../../documentation/repository-files/readme-file-best-practices.md:156 msgid "Development setup for more advanced technical contributors" msgstr "より高度な技術貢献者のための開発セットアップ" -#: ../../documentation/repository-files/readme-file-best-practices.md:155 +#: ../../documentation/repository-files/readme-file-best-practices.md:157 msgid "Your code of conduct" msgstr "あなたの行動規範" -#: ../../documentation/repository-files/readme-file-best-practices.md:156 +#: ../../documentation/repository-files/readme-file-best-practices.md:158 msgid "Licensing information" msgstr "ライセンス情報" -#: ../../documentation/repository-files/readme-file-best-practices.md:158 +#: ../../documentation/repository-files/readme-file-best-practices.md:160 msgid "" "All of the above files are important for building community around your " "project." msgstr "上記のファイルはすべて、あなたのプロジェクトを取り巻くコミュニティを構築するために重要です。" -#: ../../documentation/repository-files/readme-file-best-practices.md:161 +#: ../../documentation/repository-files/readme-file-best-practices.md:163 msgid "✔️ Citation information" msgstr "✔️ 引用情報" -#: ../../documentation/repository-files/readme-file-best-practices.md:163 +#: ../../documentation/repository-files/readme-file-best-practices.md:165 msgid "" "Finally be sure to include instructions on how to cite your package. " "Citation should include the DOI that you want used when citing your " "package, and any language that you'd like to see associated with the " "citation." -msgstr "" -"最後に、パッケージの引用方法を必ず明記してください。引用には、パッケージを引用する際に使用してほしいDOIと、引用に関連する言語を含めてください。" +msgstr "最後に、パッケージの引用方法を必ず明記してください。引用には、パッケージを引用する際に使用してほしいDOIと、引用に関連する言語を含めてください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:167 +#: ../../documentation/repository-files/readme-file-best-practices.md:169 msgid "README Resources" msgstr "READMEリソース" -#: ../../documentation/repository-files/readme-file-best-practices.md:171 +#: ../../documentation/repository-files/readme-file-best-practices.md:173 msgid "" "Below are some resources on creating great README.md files that you might" " find helpful." msgstr "以下に、優れたREADME.mdファイルを作成するためのリソースをいくつか紹介するので、参考にしてください。" -#: ../../documentation/repository-files/readme-file-best-practices.md:174 +#: ../../documentation/repository-files/readme-file-best-practices.md:176 msgid "" "[How to Write a Great README - Bane " "Sullivan](https://github.com/banesullivan/README)" @@ -2027,13 +2280,13 @@ msgstr "" "[How to Write a Great README - Bane " "Sullivan](https://github.com/banesullivan/README)" -#: ../../documentation/repository-files/readme-file-best-practices.md:175 +#: ../../documentation/repository-files/readme-file-best-practices.md:177 msgid "" "[Art of README - Kira (@hackergrrl)](https://github.com/hackergrrl/art-" "of-readme)" msgstr "" -"[Art of README - Kira (@hackergrrl)](https://github.com/hackergrrl/art-of-" -"readme)" +"[Art of README - Kira (@hackergrrl)](https://github.com/hackergrrl/art-" +"of-readme)" #: ../../documentation/write-user-documentation/create-package-tutorials.md:1 msgid "Create tutorials in your Python package documentation" @@ -2056,8 +2309,8 @@ msgid "" "`nbsphinx`) that allow you to create reproducible tutorials that are run" " when your Sphinx documentation builds." msgstr "" -"このページでは、あなたのSphinxドキュメントがビルドされたときに実行される、2つのSphinx拡張機能 (`sphinx-gallery` と " -"`nbsphinx`) について紹介します。" +"このページでは、あなたのSphinxドキュメントがビルドされたときに実行される、2つのSphinx拡張機能 (`sphinx-gallery` と" +" `nbsphinx`) について紹介します。" #: ../../documentation/write-user-documentation/create-package-tutorials.md:15 msgid "Create Python package tutorials that run when you build your docs" @@ -2077,8 +2330,7 @@ msgstr "チュートリアルを簡単にパッケージに追加できるSphinx #: ../../documentation/write-user-documentation/create-package-tutorials.md:22 msgid "[Sphinx Gallery](https://sphinx-gallery.github.io/stable/index.html) and" -msgstr "" -"[Sphinx Gallery](https://sphinx-gallery.github.io/stable/index.html) と" +msgstr "[Sphinx Gallery](https://sphinx-gallery.github.io/stable/index.html) と" #: ../../documentation/write-user-documentation/create-package-tutorials.md:23 msgid "[NbSphinx](https://nbsphinx.readthedocs.io/en/latest/)" @@ -2140,8 +2392,7 @@ msgstr "" msgid "" "Creates a rendered **.html** page with the code elements and code " "outputs in a user-friendly tutorial gallery." -msgstr "" -"レンダリングされた **.html** ページを作成し、ユーザーフレンドリーなチュートリアルギャラリーにコード要素とコード出力を表示します。" +msgstr "レンダリングされた **.html** ページを作成し、ユーザーフレンドリーなチュートリアルギャラリーにコード要素とコード出力を表示します。" #: ../../documentation/write-user-documentation/create-package-tutorials.md:41 msgid "" @@ -2187,8 +2438,8 @@ msgid "" " python script (**.py** file) and a Jupyter notebook (**.ipynb** file) at" " the bottom." msgstr "" -"`sphinx-gallery` のチュートリアルは、デフォルトでは、Pythonスクリプト (**.py** ファイル)とJupyterノートブック " -"(**.ipynb** ファイル)のダウンロードリンクが下部に含まれています。" +"`sphinx-gallery` のチュートリアルは、デフォルトでは、Pythonスクリプト (**.py** " +"ファイル)とJupyterノートブック (**.ipynb** ファイル)のダウンロードリンクが下部に含まれています。" #: ../../documentation/write-user-documentation/create-package-tutorials.md:66 msgid "Sphinx Gallery benefits" @@ -2269,8 +2520,8 @@ msgid "" "If you prefer to use Jupyter Notebooks to create tutorials you can use " "nbsphinx. nbsphinx operates similarly to Sphinx gallery in that:" msgstr "" -"もしチュートリアルを作成するのにJupyter Notebooksを使いたい場合は、nbsphinxを使うことができます。nbsphinxはSphinx" -" galleryと同じように動作します:" +"もしチュートリアルを作成するのにJupyter " +"Notebooksを使いたい場合は、nbsphinxを使うことができます。nbsphinxはSphinx galleryと同じように動作します:" #: ../../documentation/write-user-documentation/create-package-tutorials.md:119 msgid "It runs your notebooks and produces outputs in the rendered tutorials" @@ -2286,8 +2537,8 @@ msgid "" msgstr "" "Pro/con デフォルトでは **.py** と **.ipynb** ファイルのダウンロードをサポートしていません。 しかし、 " "[conf.pyの設定(epilog " -"settingsを参照)を追加したノートブックへのリンク](https://nbsphinx.readthedocs.io/en/0.8.10/prolog-" -"and-epilog.html) を追加することができます。" +"settingsを参照)を追加したノートブックへのリンク](https://nbsphinx.readthedocs.io/en/0.8.10" +"/prolog-and-epilog.html) を追加することができます。" #: ../../documentation/write-user-documentation/create-package-tutorials.md:125 msgid "" @@ -2357,8 +2608,8 @@ msgid "" msgstr "" "Pythonにおいてdocstringとは、関数、メソッド、クラスにおいて、その関数が何を行うのか、その入出力を記述したテキストを指します。 " "Pythonプログラマは通常、関数への入力を " -"[\"parameters\"](https://docs.python.org/3/glossary.html#term-parameter) または" -" [\"arguments\"](https://docs.python.org/3/faq/programming.html#faq-" +"[\"parameters\"](https://docs.python.org/3/glossary.html#term-parameter) " +"または [\"arguments\"](https://docs.python.org/3/faq/programming.html#faq-" "argument-vs-parameter) と呼び、出力を \"return values\" と呼ぶことが多いです。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:22 @@ -2372,16 +2623,15 @@ msgid "" "user better understand how to apply the function more effectively to " "their workflow." msgstr "" -"Pythonで `help()` を呼び出すと、例えば `help(add_numbers)` は関数のdocstringのテキストを表示します。 " -"このようにdocstringは、ユーザが自分のワークフローにより効果的に関数を適用する方法をよりよく理解するのに役立ちます。" +"Pythonで `help()` を呼び出すと、例えば `help(add_numbers)` は関数のdocstringのテキストを表示します。" +" このようにdocstringは、ユーザが自分のワークフローにより効果的に関数を適用する方法をよりよく理解するのに役立ちます。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:25 msgid "" "When you build your package's documentation, the docstrings can also be " "used to automatically create full API documentation that provides a clean" " view of all its functions, classes, methods, and attributes." -msgstr "" -"パッケージのドキュメントを作成するとき、docstringsを使用して、すべての関数、クラス、メソッド、属性をきれいに表示する完全なAPIドキュメントを自動的に作成することもできます。" +msgstr "パッケージのドキュメントを作成するとき、docstringsを使用して、すべての関数、クラス、メソッド、属性をきれいに表示する完全なAPIドキュメントを自動的に作成することもできます。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:28 msgid "" @@ -2404,8 +2654,7 @@ msgid "" "[You can further dig down to see what a specific function does within the" " package by clicking on an API " "element](https://www.fatiando.org/verde/latest/api/generated/verde.grid_coordinates.html#verde.grid_coordinates)" -msgstr "" -"[APIエレメントをクリックすることで、パッケージ内で特定の関数が何を行っているかをさらに掘り下げて確認することができます](https://www.fatiando.org/verde/latest/api/generated/verde.grid_coordinates.html#verde.grid_coordinates)" +msgstr "[APIエレメントをクリックすることで、パッケージ内で特定の関数が何を行っているかをさらに掘り下げて確認することができます](https://www.fatiando.org/verde/latest/api/generated/verde.grid_coordinates.html#verde.grid_coordinates)" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:33 msgid "Python package API documentation" @@ -2416,8 +2665,7 @@ msgid "" "If you have a descriptive docstring for every user-facing class, method, " "attribute and/or function in your package (_within reason_), then your " "package's API is considered well-documented." -msgstr "" -"もし、あなたのパッケージのすべてのユーザー向けクラス、メソッド、属性、関数に説明的なdocstringがあれば（_合理的な範囲内で_）、そのパッケージのAPIは十分に文書化されているとみなされます。" +msgstr "もし、あなたのパッケージのすべてのユーザー向けクラス、メソッド、属性、関数に説明的なdocstringがあれば（_合理的な範囲内で_）、そのパッケージのAPIは十分に文書化されているとみなされます。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:38 msgid "" @@ -2455,9 +2703,8 @@ msgid "" "[NumPy-style](https://numpydoc.readthedocs.io/en/latest/format.html" "#docstring-standard)" msgstr "" -"[NumPy-" -"style](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-" -"standard)" +"[NumPy-style](https://numpydoc.readthedocs.io/en/latest/format.html" +"#docstring-standard)" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:53 msgid "" @@ -2482,8 +2729,8 @@ msgid "" "#docstring-standard) for your Python documentation because:" msgstr "" "Pythonのドキュメントには [NumPy-style " -"docstrings](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-" -"standard) を使うことをお勧めします:" +"docstrings](https://numpydoc.readthedocs.io/en/latest/format.html" +"#docstring-standard) を使うことをお勧めします:" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:61 msgid "" @@ -2533,9 +2780,9 @@ msgid "" "slightly longer description of what the function does (2 to 3 sentences)." " The return of the function is also specified." msgstr "" -"以下はよく文書化された関数の良い例です。 この関数のdocstringには、関数の入力と出力（または戻り値）が記述されていることに注目してください。 " -"関数の最初の説明は短いです（1行）。 その1行の説明に続いて、関数が何をするのかについて少し長い説明があります（2～3文）。 " -"関数の戻り値も指定されています。" +"以下はよく文書化された関数の良い例です。 " +"この関数のdocstringには、関数の入力と出力（または戻り値）が記述されていることに注目してください。 関数の最初の説明は短いです（1行）。 " +"その1行の説明に続いて、関数が何をするのかについて少し長い説明があります（2～3文）。 関数の戻り値も指定されています。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:106 msgid "Best: a docstring with example use of the function" @@ -2582,8 +2829,8 @@ msgstr "" "上記では、良いdocstringフォーマット、より良いdocstringフォーマット、ベストなdocstringフォーマットの例をいくつか紹介しました。" " もしSphinxを使ってドキュメントを作成しているのであれば、 [doctest](https://www.sphinx-" "doc.org/en/master/usage/extensions/doctest.html) " -"という拡張機能をSphinxビルドに追加することができます。Doctestは、サンプルコードを含むdocstringに対して追加のチェックを行います。 " -"Doctest は、docstring `Examples` 内のサンプルコードを実行し、期待される出力が正しいかどうかをチェックします。 " +"という拡張機能をSphinxビルドに追加することができます。Doctestは、サンプルコードを含むdocstringに対して追加のチェックを行います。" +" Doctest は、docstring `Examples` 内のサンプルコードを実行し、期待される出力が正しいかどうかをチェックします。 " "ドキュメントのチュートリアルを実行するのと同様に、 `doctest` はパッケージのコード (API) " "が期待通りに動作することを保証する便利なステップになります。" @@ -2591,15 +2838,12 @@ msgstr "" msgid "" "It's important to keep in mind that examples in your docstrings help " "users using your package. Running `doctest` on those examples provides a " -"check of your package's API. doctest ensures that the functions and " +"check of your package's API. The doctest ensures that the functions and " "methods in your package run as you expect them to. Neither of these items" " replace a separate, stand-alone test suite that is designed to test your" " package's core functionality across operating systems and Python " "versions." -"docstrings にあるサンプルは、あなたのパッケージを使っているユーザーを 助けるものであるということを覚えておくことが重要です。 " -"これらのサンプルに対して `doctest` を実行することで、パッケージの API をチェックすることができます。 " -"これらの項目はどちらも、オペレーティングシステムや Python " -"のバージョンにまたがってパッケージのコア機能をテストするように設計された、独立したテストスイートを置き換えるものではありません。" +msgstr "" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:185 msgid "" @@ -2622,8 +2866,8 @@ msgid "" "value." msgstr "" "上の例では、パラメータとして関数に渡されるデータ型や、属性としてクラスに渡されるデータ型を記述するために、numpyスタイルのdocstringを使用することを見ました。" -" numpyスタイルのdocstringでは、docstringのParametersセクションにそれらのデータ型を追加します。 下の例では、パラメータ" -" `num1` と `num2` は両方とも Python の `int` (整数) 値であるべきであることがわかります。" +" numpyスタイルのdocstringでは、docstringのParametersセクションにそれらのデータ型を追加します。 " +"下の例では、パラメータ `num1` と `num2` は両方とも Python の `int` (整数) 値であるべきであることがわかります。" #: ../../documentation/write-user-documentation/document-your-code-api-docstrings.md:235 msgid "" @@ -2760,8 +3004,8 @@ msgid "" " documentation is what a user sees when they type `help(function-name)`." msgstr "" "**ユーザー向け文書** は、パッケージ内のツールがワークフローで広く使用される方法を説明する文書を指します。 **APIドキュメント** " -"は、コード内の関数、クラス、メソッド、属性のドキュメントを指し、より細かいレベルで書かれています。 このドキュメントは、ユーザーが " -"`help(function-name)` とタイプしたときに表示されるものです。" +"は、コード内の関数、クラス、メソッド、属性のドキュメントを指し、より細かいレベルで書かれています。 このドキュメントは、ユーザーが `help" +"(function-name)` とタイプしたときに表示されるものです。" #: ../../documentation/write-user-documentation/get-started.md:23 msgid "" @@ -2801,7 +3045,8 @@ msgstr "" "**パッケージコード/APIドキュメント:** パッケージの関数、クラス、メソッド、属性（API）もドキュメント化されるべきです。 " "APIドキュメントは、あなたのコードにある " "[docstrings](https://pandas.pydata.org/docs/development/contributing_docstring.html)" -" から生成することができます。 理想的には、Pythonパッケージ内のすべてのユーザー向けの関数、クラス、メソッドのdocstringがあることです。 " +" から生成することができます。 " +"理想的には、Pythonパッケージ内のすべてのユーザー向けの関数、クラス、メソッドのdocstringがあることです。 " "[コードドキュメンテーションとdocstringについてはこちらで詳しく説明します。](document-your-code-api-" "docstrings)" @@ -2848,8 +3093,7 @@ msgstr "優れたオープンソース・ドキュメントのランディング msgid "" "To make it easy for users to find what they need quickly, consider adding" " quick links on your package's landing page to the following elements:" -msgstr "" -"ユーザーが必要なものをすぐに見つけられるように、パッケージのランディングページに以下の要素へのクイックリンクを追加することを検討してください:" +msgstr "ユーザーが必要なものをすぐに見つけられるように、パッケージのランディングページに以下の要素へのクイックリンクを追加することを検討してください:" #: ../../documentation/write-user-documentation/get-started.md:52 msgid "" @@ -2937,8 +3181,7 @@ msgid "" "We talk about the elements that you should consider adding to your " "documentation, the different types of users who might read your " "documentation and how to create tutorials for your package." -msgstr "" -"ドキュメントに追加することを検討すべき要素、ドキュメントを読む可能性のあるさまざまなタイプのユーザー、パッケージのチュートリアルを作成する方法について話します。" +msgstr "ドキュメントに追加することを検討すべき要素、ドキュメントを読む可能性のあるさまざまなタイプのユーザー、パッケージのチュートリアルを作成する方法について話します。" #: ../../documentation/write-user-documentation/intro.md:10 msgid "" @@ -2955,3 +3198,47 @@ msgstr "autodocは、あなたのコードの関数、クラス、メソッド #: ../../documentation/write-user-documentation/intro.md:15 msgid "sphinx gallery for tutorials." msgstr "チュートリアルのためのsphinxギャラリー。" + +#~ msgid "Contributing File in your Python Open Source Package" +#~ msgstr "Pythonオープンソースパッケージにファイルを貢献する" + +#~ msgid "" +#~ "The contributing file should include " +#~ "information about the types of " +#~ "contributions that you welcome, and how" +#~ " you'd like to see contributions " +#~ "happen." +#~ msgstr "貢献ファイルには、歓迎する貢献の種類や、どのように貢献してほしいかについての情報を記載します。" + +#~ msgid "" +#~ "This guide should also include " +#~ "information for someone interested in " +#~ "asking questions, submitting issues or " +#~ "pull requests. It should have things " +#~ "like:" +#~ msgstr "" +#~ "このガイドには、質問や課題の提出、プルリクエストに興味がある人のための情報も含まれていなければなりません。 " +#~ "以下のようなことが書かれているべきです:" + +#~ msgid "A link to licensing information found in your README file." +#~ msgstr "READMEファイルにあるライセンス情報へのリンク。" + +#~ msgid "" +#~ "It's important to keep in mind " +#~ "that examples in your docstrings help" +#~ " users using your package. Running " +#~ "`doctest` on those examples provides a" +#~ " check of your package's API. doctest" +#~ " ensures that the functions and " +#~ "methods in your package run as you" +#~ " expect them to. Neither of these " +#~ "items replace a separate, stand-alone" +#~ " test suite that is designed to " +#~ "test your package's core functionality " +#~ "across operating systems and Python " +#~ "versions.docstrings にあるサンプルは、あなたのパッケージを使っているユーザーを " +#~ "助けるものであるということを覚えておくことが重要です。 これらのサンプルに対して `doctest` " +#~ "を実行することで、パッケージの API をチェックすることができます。 " +#~ "これらの項目はどちらも、オペレーティングシステムや Python " +#~ "のバージョンにまたがってパッケージのコア機能をテストするように設計された、独立したテストスイートを置き換えるものではありません。" +#~ msgstr "" diff --git a/locales/ja/LC_MESSAGES/index.po b/locales/ja/LC_MESSAGES/index.po index 83e4bdda2..47a6c122a 100644 --- a/locales/ja/LC_MESSAGES/index.po +++ b/locales/ja/LC_MESSAGES/index.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,28 +18,36 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" -#: ../../index.md:283 +#: ../../index.md:292 msgid "Tutorials" msgstr "チュートリアル" -#: ../../index.md:289 +#: ../../index.md:299 msgid "Packaging" msgstr "パッケージング" -#: ../../index.md:139 ../../index.md:297 +#: ../../index.md:148 ../../index.md:307 msgid "Documentation" msgstr "ドキュメンテーション" -#: ../../index.md:187 ../../index.md:305 +#: ../../index.md:196 ../../index.md:316 msgid "Tests" msgstr "テスト" -#: ../../index.md:305 +#: ../../index.md:316 msgid "Testing" msgstr "テスト" +#: ../../index.md:325 +msgid "CI/CD" +msgstr "" + +#: ../../index.md:325 +msgid "Continuous Integration" +msgstr "" + #: ../../index.md:1 msgid "pyOpenSci Python Package Guide" msgstr "pyOpenSci Pythonパッケージガイド" @@ -79,13 +87,14 @@ msgid "About this guide" msgstr "このガイドについて" #: ../../index.md:29 +#, fuzzy msgid "" "Image with the pyOpenSci flower logo in the upper right hand corner. The " "image shows the packaging lifecycle. The graphic shows a high level " -"overview of the elements of a Python package. the inside circle has 5 " +"overview of the elements of a Python package. The inside circle has 5 " "items - user documentation, code/api, test suite, contributor " "documentation, project metadata / license / readme. In the middle of the " -"circle is says maintainers and has a small icon with people. on the " +"circle is says maintainers and has a small icon with people. On the " "outside circle there is an arrow and it says infrastructure." msgstr "" "右上にpyOpenSciの花のロゴがある画像。画像はパッケージングのライフサイクルを示しています。図にはPythonパッケージの要素のハイレベルな概要が示されています。内側の円には5つの項目があります" @@ -116,8 +125,7 @@ msgstr "Pythonパッケージの作成と保守のすべてを理解する" msgid "" "You will also find best practice recommendations and curated lists of " "community resources surrounding packaging and package documentation." -msgstr "" -"また、パッケージングとパッケージドキュメンテーションにまつわるベストプラクティスの推奨や、コミュニティリソースのキュレーションリストもご覧いただけます。" +msgstr "また、パッケージングとパッケージドキュメンテーションにまつわるベストプラクティスの推奨や、コミュニティリソースのキュレーションリストもご覧いただけます。" #: ../../index.md:46 msgid "Todo" @@ -156,16 +164,16 @@ msgid "_new_ Tutorial Series: Create a Python Package" msgstr "_new_ チュートリアルシリーズ: Pythonパッケージの作成" #: ../../index.md:61 +#, fuzzy msgid "" "The first round of our community-developed, how to create a Python " "package tutorial series for scientists is complete! Join our community " -"review process or watch development of future tutorials in our [Github " +"review process or watch development of future tutorials in our [GitHub " "repo here](https://github.com/pyOpenSci/python-package-guide)." msgstr "" "コミュニティが開発した、科学者のためのPythonパッケージの作り方チュートリアルシリーズの第一弾が完成しました！ " -"コミュニティのレビュープロセスに参加したり、 [Github " -"リポジトリはこちら](https://github.com/pyOpenSci/python-package-guide) " -"で今後のチュートリアルの開発を見守ったりしてください。" +"コミュニティのレビュープロセスに参加したり、 [Github リポジトリはこちら](https://github.com/pyOpenSci" +"/python-package-guide) で今後のチュートリアルの開発を見守ったりしてください。" #: ../../index.md:71 msgid "✿ Create a Package Tutorials ✿" @@ -200,7 +208,8 @@ msgid "" "[How to add metadata to a pyproject.toml file for publication to " "PyPI.](/tutorials/pyproject-toml.md)" msgstr "" -"[PyPIに公開するためにpyproject.tomlファイルにメタデータを追加する方法](/tutorials/pyproject-toml.md)" +"[PyPIに公開するためにpyproject.tomlファイルにメタデータを追加する方法](/tutorials/pyproject-" +"toml.md)" #: ../../index.md:93 msgid "✿ Packaging Tool Tutorials ✿" @@ -211,10 +220,18 @@ msgid "[Introduction to Hatch](/tutorials/get-to-know-hatch)" msgstr "[Hatch入門](/tutorials/get-to-know-hatch)" #: ../../index.md:102 +msgid "✿ Reference Guides ✿" +msgstr "" + +#: ../../index.md:106 +msgid "[Command Line Reference Guide](/tutorials/command-line-reference)" +msgstr "" + +#: ../../index.md:111 msgid "Python Packaging for Scientists" msgstr "科学者のためのPythonパッケージング" -#: ../../index.md:104 +#: ../../index.md:113 msgid "" "Learn about Python packaging best practices. You will also get to know " "the the vibrant ecosystem of packaging tools that are available to help " @@ -223,23 +240,23 @@ msgstr "" "Python のパッケージングのベストプラクティスについて学びます。 また、Python " "のパッケージングを支援するために利用可能なパッケージングツールの活発なエコシステムを知ることができます。" -#: ../../index.md:113 +#: ../../index.md:122 msgid "✨ Create your package ✨" msgstr "✨パッケージの作成✨" -#: ../../index.md:117 +#: ../../index.md:126 msgid "[Package file structure](/package-structure-code/python-package-structure)" msgstr "[パッケージファイル構造](/package-structure-code/python-package-structure)" -#: ../../index.md:118 +#: ../../index.md:127 msgid "" "[Package metadata / pyproject.toml](package-structure-code/pyproject-" "toml-python-package-metadata.md)" msgstr "" -"[パッケージメタデータ / pyproject.toml](package-structure-code/pyproject-toml-python-" -"package-metadata.md)" +"[パッケージメタデータ / pyproject.toml](package-structure-code/pyproject-toml-" +"python-package-metadata.md)" -#: ../../index.md:119 +#: ../../index.md:128 msgid "" "[Build your package (sdist / wheel)](package-structure-code/python-" "package-distribution-files-sdist-wheel.md)" @@ -247,11 +264,11 @@ msgstr "" "[パッケージのビルド (sdist / wheel)](package-structure-code/python-package-" "distribution-files-sdist-wheel.md)" -#: ../../index.md:120 +#: ../../index.md:129 msgid "[Declare dependencies](package-structure-code/declare-dependencies.md)" msgstr "[依存関係の宣言](package-structure-code/declare-dependencies.md)" -#: ../../index.md:121 +#: ../../index.md:130 msgid "" "[Navigate the packaging tool ecosystem](package-structure-code/python-" "package-build-tools.md)" @@ -259,209 +276,211 @@ msgstr "" "[パッケージングツールのエコシステムをナビゲートする](package-structure-code/python-package-build-" "tools.md)" -#: ../../index.md:122 +#: ../../index.md:131 msgid "" "[Non pure Python builds](package-structure-code/complex-python-package-" "builds.md)" msgstr "" -"[純粋な Python 以外のビルド](package-structure-code/complex-python-package-builds.md)" +"[純粋な Python 以外のビルド](package-structure-code/complex-python-package-" +"builds.md)" -#: ../../index.md:127 +#: ../../index.md:136 msgid "✨ Publish your package ✨" msgstr "✨パッケージを公開する✨" -#: ../../index.md:131 +#: ../../index.md:140 msgid "" "Gain a better understanding of the Python packaging ecosystem Learn about" " best practices for:" msgstr "Pythonのパッケージングエコシステムをより深く理解するためのベストプラクティスを学ぶ:" -#: ../../index.md:134 +#: ../../index.md:143 msgid "" "[Package versioning & release](/package-structure-code/python-package-" "versions.md)" -msgstr "" -"[パッケージのバージョン管理とリリース](/package-structure-code/python-package-versions.md)" +msgstr "[パッケージのバージョン管理とリリース](/package-structure-code/python-package-versions.md)" -#: ../../index.md:135 +#: ../../index.md:144 msgid "" "[Publish to PyPI & Conda-forge](/package-structure-code/publish-python-" "package-pypi-conda.md)" msgstr "" -"[PyPIとConda-forgeへの公開](/package-structure-code/publish-python-package-pypi-" -"conda.md)" +"[PyPIとConda-forgeへの公開](/package-structure-code/publish-python-package-" +"pypi-conda.md)" -#: ../../index.md:148 +#: ../../index.md:157 msgid "✨ Write The Docs ✨" msgstr "✨ドキュメントを書く✨" -#: ../../index.md:151 +#: ../../index.md:160 msgid "" "[Create documentation for your users](/documentation/write-user-" "documentation/intro)" msgstr "[ユーザーのための文書を作成する](/documentation/write-user-documentation/intro)" -#: ../../index.md:152 +#: ../../index.md:161 msgid "" "[Core files to include in your package repository](/documentation" "/repository-files/intro)" msgstr "[パッケージリポジトリに含めるコアファイル](/documentation/repository-files/intro)" -#: ../../index.md:153 +#: ../../index.md:162 msgid "" "[Write tutorials to show how your package is used](/documentation/write-" "user-documentation/create-package-tutorials)" msgstr "" -"[パッケージがどのように使われるかを示すチュートリアルを書く](/documentation/write-user-" -"documentation/create-package-tutorials)" +"[パッケージがどのように使われるかを示すチュートリアルを書く](/documentation/write-user-documentation" +"/create-package-tutorials)" -#: ../../index.md:158 +#: ../../index.md:167 msgid "✨ Developer Docs ✨" msgstr "✨開発者向けドキュメント✨" -#: ../../index.md:161 +#: ../../index.md:170 msgid "" "[Create documentation for collaborating developers](/documentation" "/repository-files/contributing-file)" -msgstr "" -"[共同開発者のためのドキュメントの作成](/documentation/repository-files/contributing-file)" +msgstr "[共同開発者のためのドキュメントの作成](/documentation/repository-files/contributing-file)" -#: ../../index.md:162 +#: ../../index.md:171 msgid "" "[Write a development guide](/documentation/repository-files/development-" "guide)" msgstr "[開発ガイドを書く](/documentation/repository-files/development-guide)" -#: ../../index.md:167 +#: ../../index.md:176 msgid "✨ Document For A Community ✨" msgstr "✨コミュニティのためのドキュメント✨" -#: ../../index.md:170 +#: ../../index.md:179 msgid "" "[Writing a README file](/documentation/repository-files/readme-file-best-" "practices)" msgstr "" -"[READMEファイルの書き方](/documentation/repository-files/readme-file-best-practices)" +"[READMEファイルの書き方](/documentation/repository-files/readme-file-best-" +"practices)" -#: ../../index.md:171 +#: ../../index.md:180 msgid "" "[Set norms with a Code of Conduct](/documentation/repository-files/code-" "of-conduct-file)" msgstr "[行動規範で規範を定める](/documentation/repository-files/code-of-conduct-file)" -#: ../../index.md:172 +#: ../../index.md:181 msgid "[License your package](/documentation/repository-files/license-files)" msgstr "[パッケージのライセンス](/documentation/repository-files/license-files)" -#: ../../index.md:177 +#: ../../index.md:186 msgid "✨ Publish Your Docs ✨" msgstr "✨ドキュメントを公開する✨" -#: ../../index.md:180 +#: ../../index.md:189 msgid "[How to publish your docs](/documentation/hosting-tools/intro)" msgstr "[ドキュメントを公開する方法](/documentation/hosting-tools/intro)" -#: ../../index.md:181 +#: ../../index.md:190 msgid "[Using Sphinx](/documentation/hosting-tools/intro)" msgstr "[Sphinxを使う](/documentation/hosting-tools/intro)" -#: ../../index.md:182 +#: ../../index.md:191 msgid "" "[Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-" "rst-doc-syntax)" msgstr "" -"[Markdown、MyST、およびReST](/documentation/hosting-tools/myst-markdown-rst-doc-" -"syntax)" +"[Markdown、MyST、およびReST](/documentation/hosting-tools/myst-markdown-rst-" +"doc-syntax)" -#: ../../index.md:183 +#: ../../index.md:192 +#, fuzzy msgid "" -"[Host your docs on Read The Docs or Github Pages](/documentation/hosting-" +"[Host your docs on Read The Docs or GitHub Pages](/documentation/hosting-" "tools/publish-documentation-online)" msgstr "" "[Read The Docs または Github Pages でドキュメントをホストする](/documentation/hosting-" "tools/publish-documentation-online)" -#: ../../index.md:189 +#: ../../index.md:198 msgid "" "*We are actively working on this section. [Follow development " "here.](https://github.com/pyOpenSci/python-package-guide)*" msgstr "" -"*私たちはこのセクションに積極的に取り組んでいます。 " -"[開発のフォローはこちら](https://github.com/pyOpenSci/python-package-guide)*" +"*私たちはこのセクションに積極的に取り組んでいます。 [開発のフォローはこちら](https://github.com/pyOpenSci" +"/python-package-guide)*" -#: ../../index.md:197 +#: ../../index.md:206 msgid "✨ Tests for your Python package ✨" msgstr "✨Pythonパッケージのテスト✨" -#: ../../index.md:200 +#: ../../index.md:209 msgid "[Intro to testing](tests/index.md)" msgstr "[テスト入門](tests/index.md)" -#: ../../index.md:201 +#: ../../index.md:210 msgid "[Write tests](tests/write-tests)" msgstr "[テストを書く](tests/write-tests)" -#: ../../index.md:202 +#: ../../index.md:211 msgid "[Types of tests](tests/test-types)" msgstr "[テストの種類](tests/test-types)" -#: ../../index.md:207 +#: ../../index.md:216 msgid "✨ Run your tests ✨" msgstr "✨テストの実行✨" -#: ../../index.md:210 +#: ../../index.md:219 msgid "[Run tests locally](tests/run-tests)" msgstr "[ローカルでテストを実行する](tests/run-tests)" -#: ../../index.md:211 +#: ../../index.md:220 msgid "[Run tests in CI](tests/tests-ci)" msgstr "[CIでテストを実行する](tests/tests-ci)" -#: ../../index.md:215 +#: ../../index.md:224 msgid "Contributing" msgstr "貢献" -#: ../../index.md:225 +#: ../../index.md:234 msgid "✨ Code style & Format ✨" msgstr "✨コードスタイルとフォーマット✨" -#: ../../index.md:230 +#: ../../index.md:239 msgid "[Code style](package-structure-code/code-style-linting-format.md)" msgstr "[コードスタイル](package-structure-code/code-style-linting-format.md)" -#: ../../index.md:235 +#: ../../index.md:244 msgid "✨ Want to contribute? ✨" msgstr "✨貢献したいですか？ ✨" -#: ../../index.md:240 +#: ../../index.md:249 msgid "" "We welcome contributions to this guide. Learn more about how you can " "contribute." msgstr "このガイドへのご貢献をお待ちしております。貢献方法についてはこちらをご覧ください。" -#: ../../index.md:246 +#: ../../index.md:255 +#, fuzzy msgid "" "xkcd comic showing a stick figure on the ground and one in the air. The " "one on the ground is saying. `You're flying! how?` The person in the air" " replies `Python!` Below is a 3 rectangle comic with the following text " -"in each box. box 1 - I learned it last night. Everything is so simple. " -"Hello world is just print hello world. box 2 - the person on the ground " -"says - come join us programming is fun again. it's a whole new world. But" +"in each box. Box 1 - I learned it last night. Everything is so simple. " +"Hello world is just print hello world. Box 2 - the person on the ground " +"says - come join us programming is fun again. It's a whole new world. But" " how are you flying? box 3 - the person flying says - i just typed import" " antigravity. I also sampled everything in the medicine cabinet. But i " -"think this is the python. the person on the ground is saying - that's it?" +"think this is the python. The person on the ground is saying - that's it?" msgstr "" -"xkcdの漫画で、地面に置かれた棒人間と空中にある棒人間が描かれている。地上にいる人が言っている。 `あなたは飛んでいる！どうやって？` 空中にいる人は" -" `Python!` と答える。以下は3つの長方形のマンガで、各ボックスに次のテキストが入っている。ボックス1 - " +"xkcdの漫画で、地面に置かれた棒人間と空中にある棒人間が描かれている。地上にいる人が言っている。 `あなたは飛んでいる！どうやって？` " +"空中にいる人は `Python!` と答える。以下は3つの長方形のマンガで、各ボックスに次のテキストが入っている。ボックス1 - " "昨夜学んだ。すべてがとてもシンプルだ。Hello worldはprint hello worldだけ。ボックス2 - " "地上にいる人が言う。まったく新しい世界だ。でもどうやって飛んでるの？ボックス3 - 飛んでいる人はこう言う。- " "`反重力をインポートしました。薬箱の中のものも全部試しました。でもこれがpythonだと思う。地上の人はこう言っている。- これで終わり？" -#: ../../index.md:252 +#: ../../index.md:261 msgid "A community-created guidebook" msgstr "コミュニティが作るガイドブック" -#: ../../index.md:254 +#: ../../index.md:263 msgid "" "Every page in this guidebook goes through an extensive community review " "process. To ensure our guidebook is both beginner-friendly and accurate, " @@ -471,41 +490,41 @@ msgstr "" "このガイドブックのすべてのページは、コミュニティの広範なレビュープロセスを経ています。 " "このガイドブックが初心者にやさしく、正確であることを保証するために、私たちは幅広いスキルと専門知識を持つ多様なpythonistaや科学者からのレビューを奨励しています。" -#: ../../index.md:257 +#: ../../index.md:266 msgid "View guidebook contributors" msgstr "ガイドブックの貢献者を見る" -#: ../../index.md:265 +#: ../../index.md:274 msgid "Who this guidebook is for" msgstr "このガイドブックの対象者" -#: ../../index.md:267 +#: ../../index.md:276 msgid "" "This guidebook is for anyone interested in learning more about Python " "packaging. It is beginner-friendly and will provide:" msgstr "このガイドブックはPythonのパッケージングについてもっと学びたいと思っている人のためのものです。 初心者に優しく、以下を提供します:" -#: ../../index.md:269 +#: ../../index.md:278 msgid "Beginning-to-end guidance on creating a Python package." msgstr "Pythonパッケージの作成に関する初歩から終わりまでのガイダンス。" -#: ../../index.md:270 +#: ../../index.md:279 msgid "" "Resources to help you navigate the Python packaging ecosystem of tools " "and approaches to packaging." msgstr "Python のパッケージングエコシステムをナビゲートするのに役立つリソースです。" -#: ../../index.md:271 +#: ../../index.md:280 msgid "" "A curated list of resources to help you get your package into documented," " usable and maintainable shape." msgstr "あなたのパッケージが文書化され、使用可能で保守可能な形になるのを助けるリソースの厳選されたリストです。" -#: ../../index.md:273 +#: ../../index.md:282 msgid "Where this guide is headed" msgstr "このガイドの方向性" -#: ../../index.md:275 +#: ../../index.md:284 msgid "" "If you have ideas of things you'd like to see here clarified in this " "guide, [we invite you to open an issue on " @@ -515,7 +534,7 @@ msgstr "" "[GitHubにissueを開いてください。](https://github.com/pyOpenSci/python-package-" "guide/issues) 。" -#: ../../index.md:278 +#: ../../index.md:287 msgid "" "If you have questions about our peer review process or packaging in " "general, you are welcome to use our [pyOpenSci Discourse " @@ -524,11 +543,12 @@ msgstr "" "レビュープロセスやパッケージング全般について質問がある場合は、 [pyOpenSci Discourse " "forum](https://pyopensci.discourse.group/) をご利用ください。" -#: ../../index.md:280 +#: ../../index.md:289 +#, fuzzy msgid "" -"This is a living guide that is updated as tools and best practices evolve" -" in the Python packaging ecosystem. We will be adding new content over " -"the next year." +"This living Python packaging guide is updated as tools and best practices" +" evolve in the Python packaging ecosystem. We will be adding new content " +"over the next year." msgstr "" "これは Python のパッケージングエコシステムにおけるツールやベストプラクティスの進化に合わせて更新される生きたガイドです。 " "来年にかけて新しいコンテンツを追加していく予定です。" diff --git a/locales/ja/LC_MESSAGES/package-structure-code.po b/locales/ja/LC_MESSAGES/package-structure-code.po index f02e7e1e1..98465b930 100644 --- a/locales/ja/LC_MESSAGES/package-structure-code.po +++ b/locales/ja/LC_MESSAGES/package-structure-code.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,7 +18,7 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" #: ../../package-structure-code/code-style-linting-format.md:1 msgid "Python Package Code Style, Format and Linters" @@ -496,7 +496,7 @@ msgstr "" #: ../../package-structure-code/code-style-linting-format.md:262 msgid "" "The pre-commit workflow begins with you adding files that have changes to" -" be staged in git. Next, you'd run git commit. when you run git commit, " +" be staged in git. Next, you'd run git commit. When you run git commit, " "the pre-commit hooks will then run. In this example, Black, the code " "formatter and flake8, a linter both run. If all of the files pass Black " "and flake8 checks, then your commit will be recorded. If they don't, the " @@ -524,7 +524,7 @@ msgstr "" msgid "" "In addition to calling tools, Pre-commit also has a suite of [built in " "format hooks](https://github.com/pre-commit/pre-commit-hooks#hooks-" -"available) that you can call. Some, such as trailing-whitespace can be " +"available) that you can call. Some, such as `trailing-whitespace` can be " "also useful to add to your pre-commit workflow to ensure clean, " "streamlined code files." msgstr "" @@ -705,7 +705,7 @@ msgstr "" msgid "" "**Python packages that have extensions written in different languages " "(e.g. Fortran and C++) or that have non Python dependencies that are " -"difficult to install (e.g. GDAL)** These packages often have complex " +"difficult to install (e.g. GDAL):** These packages often have complex " "build steps (more complex than a package with just a few C extensions for" " instance). As such, these packages require tools such as [scikit-" "build](https://scikit-build.readthedocs.io/en/latest/) or [meson-" @@ -753,7 +753,7 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:8 #: ../../package-structure-code/declare-dependencies.md:375 -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:25 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:22 msgid "Todo" msgstr "" @@ -762,7 +762,7 @@ msgid "" "keep this comment - https://github.com/pyOpenSci/python-package-" "guide/pull/106#issuecomment-1844278487 in this file for now - jeremiah " "did a nice inventory of common shells and whether they need quotes or " -"not. it's really comprehensive. but do we want it in the guide?? it's " +"not. It's really comprehensive. But do we want it in the guide?? it's " "really useful for more advanced users i think." msgstr "" @@ -797,18 +797,18 @@ msgid "" msgstr "" #: ../../package-structure-code/declare-dependencies.md:29 -msgid "needs to function properly." +msgid "Needs to function properly." msgstr "" #: ../../package-structure-code/declare-dependencies.md:30 msgid "" -"requires if someone wants to develop / work on improving your package " +"Requires if someone wants to develop / work on improving your package " "locally or" msgstr "" #: ../../package-structure-code/declare-dependencies.md:31 msgid "" -"requires if a user wants to add additional functionality (that is not " +"Requires if a user wants to add additional functionality (that is not " "core) to your package" msgstr "" @@ -826,9 +826,10 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:38 msgid "" "You can think about dependencies as being either optional or required. If" -" they are required, they will be listed in the `[dependency] =` table of " -"your `pyproject.toml` file. If they are optional, they will be listed in " -"the `[optional.dependencies]` table of your `pyproject.toml`." +" they are required, they will be listed in the `dependencies` key in the " +"`project` table of your `pyproject.toml` file. If they are optional, they" +" will be listed in the `[optional.dependencies]` table of your " +"`pyproject.toml`." msgstr "" #: ../../package-structure-code/declare-dependencies.md:40 @@ -858,8 +859,8 @@ msgid "" "Required dependencies are called directly within your package's code. On " "this page we refer to these dependencies as **core dependencies** as they" " are needed in order to run your package. You should place your core or " -"required dependencies in the `[dependency]=` table of your " -"`pyproject.toml` file." +"required dependencies in the `dependencies` key of the `[project]` table " +"of your `pyproject.toml` file." msgstr "" #: ../../package-structure-code/declare-dependencies.md:56 @@ -960,9 +961,10 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:121 msgid "" "Ideally, you should only list the packages that are necessary to install " -"and use your package in the `[dependencies]` section. This minimizes the " -"number of additional packages that your users must install as well as the" -" number of packages that depend upon your package must also install." +"and use your package in the `dependencies` key in the `[project]` table. " +"This minimizes the number of additional packages that your users must " +"install as well as the number of packages that depend upon your package " +"must also install." msgstr "" #: ../../package-structure-code/declare-dependencies.md:128 @@ -1038,23 +1040,23 @@ msgstr "" msgid "" "These dependencies are considered optional, because they are not required" " to install and use your package. Feature dependencies are considered " -"optional and should also be placed in the `[optional.dependencies]` " -"table." +"optional and should also be placed in the `[project.optional-" +"dependencies]` table." msgstr "" #: ../../package-structure-code/declare-dependencies.md:158 msgid "" -"Optional dependencies can be stored in an `[optional.dependencies]` table" -" in your **pyproject.toml** file." +"Optional dependencies can be stored in an `[project.optional-" +"dependencies]` table in your **pyproject.toml** file." msgstr "" #: ../../package-structure-code/declare-dependencies.md:161 msgid "" -"It's important to note that within the `[optional.dependencies]` table, " -"you can store additional, optional dependencies within named sub-groups. " -"This is a different table than the dependencies array located within the " -"`[project]` table discussed above which contains a single array with a " -"single list of required packages." +"It's important to note that within the `[project.optional-dependencies]` " +"table, you can store additional, optional dependencies within named sub-" +"groups. This is a different table than the dependencies array located " +"within the `[project]` table discussed above which contains a single " +"array with a single list of required packages." msgstr "" #: ../../package-structure-code/declare-dependencies.md:163 @@ -1066,7 +1068,9 @@ msgid "To declare optional dependencies in your **pyproject.toml** file:" msgstr "" #: ../../package-structure-code/declare-dependencies.md:167 -msgid "Add a `[optional.dependencies]` table to your **pyproject.toml** file." +msgid "" +"Add a `[project.optional-dependencies]` table to your **pyproject.toml** " +"file." msgstr "" #: ../../package-structure-code/declare-dependencies.md:168 @@ -1126,11 +1130,11 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:226 msgid "" -"Diagram showing a ven diagram with three sections representing the " +"Diagram showing a Venn diagram with three sections representing the " "dependency groups listed above - docs feature and tests. In the center it" " says your-package and lists the core dependencies of that package " "seaborn and numpy. To the right are two arrows. The first shows the " -"command python - m pip install your-package. it them shows how installing" +"command python - m pip install your-package. It them shows how installing" " your package that way installs only the package and the two core " "dependencies into a users environment. Below is a second arrow with " "python -m pip install youPackage[tests]. This leads to an environment " @@ -1140,11 +1144,12 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:228 msgid "" -"When a user installs your package locally using python -m pip install " -"your-package only your package and it's core dependencies get installed. " -"When they install your package `[tests]` pip will install both your " -"package and its core dependencies plus any of the dependencies listed " -"within the tests array of your `[optional.dependencies]` table." +"When a user installs your package locally using `python -m pip install " +"your-package` only your package and it's core dependencies get installed." +" When they install your package `python -m pip install your-" +"package[tests]` pip will install both your package and its core " +"dependencies plus any of the dependencies listed within the tests array " +"of your `[project.optional-dependencies]` table." msgstr "" #: ../../package-structure-code/declare-dependencies.md:231 @@ -1194,7 +1199,7 @@ msgid "dependencies needed for your documentation (`docs`)," msgstr "" #: ../../package-structure-code/declare-dependencies.md:253 -msgid "required package dependencies in the `dependency` array and" +msgid "required package dependencies in the `dependencies` array and" msgstr "" #: ../../package-structure-code/declare-dependencies.md:254 @@ -1214,8 +1219,8 @@ msgstr "" #: ../../package-structure-code/declare-dependencies.md:261 msgid "" -"You can install multiple dependency groups in the " -"`[optional.dependencies]` table using:" +"You can install multiple dependency groups in the `[project.optional-" +"dependencies]` table using:" msgstr "" #: ../../package-structure-code/declare-dependencies.md:263 @@ -1421,89 +1426,111 @@ msgstr "" msgid "This is hidden. TO" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Intro" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Python package structure" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "pyproject.toml Package Metadata" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Build Your Package" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Declare dependencies" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Package Build Tools" msgstr "" -#: ../../package-structure-code/intro.md:163 +#: ../../package-structure-code/intro.md:179 msgid "Complex Builds" msgstr "" -#: ../../package-structure-code/intro.md:163 -msgid "Package structure & code style" +#: ../../package-structure-code/intro.md:179 +msgid "Create & Build Your Package" msgstr "" -#: ../../package-structure-code/intro.md:177 +#: ../../package-structure-code/intro.md:193 msgid "Publish with Conda / PyPI" msgstr "" -#: ../../package-structure-code/intro.md:177 +#: ../../package-structure-code/intro.md:193 msgid "Package versions" msgstr "" -#: ../../package-structure-code/intro.md:177 +#: ../../package-structure-code/intro.md:193 msgid "Code style" msgstr "" -#: ../../package-structure-code/intro.md:177 -msgid "Publishing a package" +#: ../../package-structure-code/intro.md:193 +msgid "Publish your package" msgstr "" #: ../../package-structure-code/intro.md:1 -msgid "Python package structure information" +msgid "Python Package Structure" msgstr "" #: ../../package-structure-code/intro.md:3 msgid "" "This section provides guidance on your Python package's structure, code " -"formats and style. It also reviews the various packaging tools that you " -"can use to support building and publishing your package." +"format, and style. It also reviews the various [packaging tools](python-" +"package-build-tools) you can use to [build](python-package-distribution-" +"files-sdist-wheel) and [publish](publish-python-package-pypi-conda) your " +"Python package." msgstr "" #: ../../package-structure-code/intro.md:7 msgid "" +"If you want end-to-end tutorials, check out our tutorial series that " +"starts by introducing [what a Python package is](what-is-a-package)." +msgstr "" + +#: ../../package-structure-code/intro.md:9 +msgid "" "If you are confused by Python packaging, you are not alone! The good news" -" is there are some great modern packaging tools that ensure that you're " -"following best practices. Here, we review tool features and suggest tools" -" that might be best fitted for your workflow." +" is that some great modern packaging tools ensure you follow best " +"practices. Here, we review tool features and suggest tools you can use " +"for your Python packaging workflow." msgstr "" -#: ../../package-structure-code/intro.md:19 -msgid "✨ 1. Package file structure ✨" +#: ../../package-structure-code/intro.md:14 +msgid "Checkout our beginning-to-end create a Python package tutorials" msgstr "" #: ../../package-structure-code/intro.md:23 +msgid "How this content is developed" +msgstr "" + +#: ../../package-structure-code/intro.md:24 +msgid "" +"All of the content in this guide has been vetted by community members, " +"including maintainers and developers of the core packaging tools." +msgstr "" + +#: ../../package-structure-code/intro.md:35 +msgid "✨ 1. Package file structure ✨" +msgstr "" + +#: ../../package-structure-code/intro.md:39 msgid "" "src layout, flat layout and where should tests folders live? No matter " "what your level of packaging knowledge is, this page will help you decide" " upon a package structure that follows modern python best practices." msgstr "" -#: ../../package-structure-code/intro.md:28 +#: ../../package-structure-code/intro.md:44 msgid "✨ 2. Learn about building your package ✨" msgstr "" -#: ../../package-structure-code/intro.md:32 +#: ../../package-structure-code/intro.md:48 msgid "" "To publish your Python package on PyPI, you will need to first build it. " "The act of \"building\" refers to the process of placing your package " @@ -1511,73 +1538,73 @@ msgid "" " about building your Python package." msgstr "" -#: ../../package-structure-code/intro.md:41 +#: ../../package-structure-code/intro.md:57 msgid "✨ 4. Add metadata ✨" msgstr "" -#: ../../package-structure-code/intro.md:45 +#: ../../package-structure-code/intro.md:61 msgid "" "Learn how to add project metadata to your Python package to support both " "filtering on PyPI and also the metadata that a package installer needs to" " build and install your package." msgstr "" -#: ../../package-structure-code/intro.md:52 +#: ../../package-structure-code/intro.md:68 msgid "✨ 3. What Python package tool should you use? ✨" msgstr "" -#: ../../package-structure-code/intro.md:56 +#: ../../package-structure-code/intro.md:72 msgid "" "Learn more about the suite of packaging tools out there. And learn which " "tool might be best for you." msgstr "" -#: ../../package-structure-code/intro.md:62 +#: ../../package-structure-code/intro.md:78 msgid "✨ 4. Publish to PyPI and Conda ✨" msgstr "" -#: ../../package-structure-code/intro.md:66 +#: ../../package-structure-code/intro.md:82 msgid "" "If you have a pure Python package, it's a straight forward process to " "publish to both PyPI and then a Conda channel such as conda-forge. Learn " "more here." msgstr "" -#: ../../package-structure-code/intro.md:73 +#: ../../package-structure-code/intro.md:89 msgid "✨ 5. Setup package versioning ✨" msgstr "" -#: ../../package-structure-code/intro.md:77 +#: ../../package-structure-code/intro.md:93 msgid "" "Semver (numeric versioning) and Calver (versioning using the date) are 2 " "common ways to version a package. Which one should you pick? Learn more " "here." msgstr "" -#: ../../package-structure-code/intro.md:83 +#: ../../package-structure-code/intro.md:99 msgid "✨ 6. Code style & linters ✨" msgstr "" -#: ../../package-structure-code/intro.md:87 +#: ../../package-structure-code/intro.md:103 msgid "" "Black, blue, flake8, Ruff - which tools can help you ensure your package " "follows best practices for code format? Learn more about the options and " "why this is important here." msgstr "" -#: ../../package-structure-code/intro.md:95 +#: ../../package-structure-code/intro.md:111 msgid "" "Figure showing a decision tree with the various packaging tool front-end " "and back-end options." msgstr "" -#: ../../package-structure-code/intro.md:97 +#: ../../package-structure-code/intro.md:113 msgid "" "Diagram showing the various front-end build tools that you can select " "from. See the packaging tools page to learn more about each tool." msgstr "" -#: ../../package-structure-code/intro.md:102 +#: ../../package-structure-code/intro.md:118 msgid "" "If you are considering submitting a package for peer review, have a look " "at the bare-minimum [editor checks](https://www.pyopensci.org/software-" @@ -1588,34 +1615,34 @@ msgid "" "package." msgstr "" -#: ../../package-structure-code/intro.md:109 +#: ../../package-structure-code/intro.md:125 msgid "What you will learn here" msgstr "" -#: ../../package-structure-code/intro.md:111 +#: ../../package-structure-code/intro.md:127 msgid "In this section of our Python packaging guide, we:" msgstr "" -#: ../../package-structure-code/intro.md:113 +#: ../../package-structure-code/intro.md:129 msgid "" "Provide an overview of the options available to you when packaging your " -"tool." +"code." msgstr "" -#: ../../package-structure-code/intro.md:115 +#: ../../package-structure-code/intro.md:131 msgid "" "Suggest tools and approaches that both meet your needs and also support " "existing standards." msgstr "" -#: ../../package-structure-code/intro.md:117 +#: ../../package-structure-code/intro.md:133 msgid "" "Suggest tools and approaches that will allow you to expand upon a " -"workflow that may begin as a pure Python tool and evolve into a tool that" -" requires addition layers of complexity in the packaging build." +"workflow that may begin as a pure Python code and evolve into code that " +"requires addition layers of complexity in the packaging build." msgstr "" -#: ../../package-structure-code/intro.md:120 +#: ../../package-structure-code/intro.md:136 msgid "" "Align our suggestions with the most current, accepted [PEPs (Python " "Enhancement Protocols)](https://peps.python.org/pep-0000/) and the " @@ -1623,18 +1650,18 @@ msgid "" "python.org/specs/)." msgstr "" -#: ../../package-structure-code/intro.md:123 +#: ../../package-structure-code/intro.md:139 msgid "" "In an effort to maintain consistency within our community, we also align " "with existing best practices being implemented by developers of core " "Scientific Python packages such as Numpy, SciPy and others." msgstr "" -#: ../../package-structure-code/intro.md:127 +#: ../../package-structure-code/intro.md:143 msgid "Guidelines for pyOpenSci's packaging recommendations" msgstr "" -#: ../../package-structure-code/intro.md:129 +#: ../../package-structure-code/intro.md:145 msgid "" "The flexibility of the Python programming language lends itself to a " "diverse range of tool options for creating a Python package. Python is so" @@ -1644,7 +1671,7 @@ msgid "" "language](https://numpy.org/doc/stable/user/c-info.python-as-glue.html)\"" msgstr "" -#: ../../package-structure-code/intro.md:135 +#: ../../package-structure-code/intro.md:151 msgid "" "If you are building a pure Python package, then your packaging setup can " "be simple. However, some scientific packages have complex requirements as" @@ -1652,41 +1679,41 @@ msgid "" "such as C or C++." msgstr "" -#: ../../package-structure-code/intro.md:139 +#: ../../package-structure-code/intro.md:155 msgid "" "To support the many different uses of Python, there are many ways to " "create a Python package. In this guide, we suggest packaging approaches " "and tools based on:" msgstr "" -#: ../../package-structure-code/intro.md:142 +#: ../../package-structure-code/intro.md:158 msgid "" "What we think will be best and easiest to adopt for those who are newer " "to packaging." msgstr "" -#: ../../package-structure-code/intro.md:144 +#: ../../package-structure-code/intro.md:160 msgid "Tools that we think are well maintained and documented." msgstr "" -#: ../../package-structure-code/intro.md:145 +#: ../../package-structure-code/intro.md:161 msgid "" "A shared goal of standardizing packaging approaches across this " "(scientific) Python ecosystem." msgstr "" -#: ../../package-structure-code/intro.md:148 +#: ../../package-structure-code/intro.md:164 msgid "" "Here, we also try to align our suggestions with the most current, " "accepted [Python community](https://packaging.python.org/en/latest/) and " "[scientific community](https://scientific-python.org/specs/)." msgstr "" -#: ../../package-structure-code/intro.md:151 +#: ../../package-structure-code/intro.md:167 msgid "Suggestions in this guide are not pyOpenSci review requirements" msgstr "" -#: ../../package-structure-code/intro.md:154 +#: ../../package-structure-code/intro.md:170 msgid "" "The suggestions for package layout in this section are made with the " "intent of being helpful; they are not specific requirements for your " @@ -1694,7 +1721,7 @@ msgid "" "ecosystem." msgstr "" -#: ../../package-structure-code/intro.md:158 +#: ../../package-structure-code/intro.md:174 msgid "" "Please check out our [package scope page](https://www.pyopensci.org" "/software-peer-review/about/package-scope.html) and [review requirements " @@ -1744,7 +1771,7 @@ msgstr "" msgid "" "Image showing the progression of creating a Python package, building it " "and then publishing to PyPI and conda-forge. You take your code and turn " -"it into distribution files (sdist and wheel) that PyPI accepts. then " +"it into distribution files (sdist and wheel) that PyPI accepts. Then " "there is an arrow towards the PyPI repository where ou publish both " "distributions. From PyPI if you create a conda-forge recipe you can then " "publish to conda-forge." @@ -1754,8 +1781,8 @@ msgstr "" msgid "" "Once you have published both package distributions (the source " "distribution and the wheel) to PyPI, you can then publish to conda-forge." -" conda-forge requires a source distribution on PyPI in order to build " -"your package on conda-forge. You do not need to rebuild your package to " +" The conda-forge requires a source distribution on PyPI in order to build" +" your package on conda-forge. You do not need to rebuild your package to " "publish to conda-forge." msgstr "" @@ -1880,15 +1907,15 @@ msgstr "" #: ../../package-structure-code/publish-python-package-pypi-conda.md:99 msgid "" -"[**conda-forge:**](https://anaconda.org/conda-forge) this is a community-" -"driven channel that focuses on scientific packages. This channel is ideal" -" for tools that support geospatial data. Anyone can publish a package to " -"this channel." +"[**conda-forge:**](https://conda-forge.org/) this is a community-driven " +"channel that focuses on scientific packages. This channel is ideal for " +"tools that support geospatial data. Anyone can publish a package to this " +"channel." msgstr "" #: ../../package-structure-code/publish-python-package-pypi-conda.md:100 msgid "" -"[**bioconda**](https://anaconda.org/bioconda): this channel focuses on " +"[**bioconda**](https://bioconda.github.io/): this channel focuses on " "biomedical tools." msgstr "" @@ -1903,10 +1930,10 @@ msgid "" "Graphic with the title Python package repositories. Below it says " "Anything hosted on PyPI can be installed using pip install. Packaging " "hosted on a conda channel can be installed using conda install. Below " -"that there are two rows. the top row says conda channels. next to it are " +"that there are two rows. The top row says conda channels. Next to it are " "three boxes one with conda-forge, community maintained; bioconda and then" " default - managed by the anaconda team. Below that there is a row that " -"says PyPI servers. PyPI - anyone can publish to PyPI. and test PyPI. a " +"says PyPI servers. PyPI - anyone can publish to PyPI. And test PyPI. A " "testbed server for you to practice." msgstr "" @@ -1972,7 +1999,7 @@ msgstr "" #: ../../package-structure-code/publish-python-package-pypi-conda.md:144 msgid "" -"Similarly installing packages from the default anaconda package mixed " +"Similarly installing packages from the default anaconda channel mixed " "with the conda-forge channel can also lead to dependency conflicts." msgstr "" @@ -2082,30 +2109,30 @@ msgstr "" msgid "Use a pyproject.toml file for your package configuration & metadata" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:12 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:10 msgid "Important pyproject.toml take aways" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:16 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:14 msgid "" "There are only two tables that are required for an installable Python " "package: **[build-system]** and **[project]**. The **[project]** table " "stores your package's metadata." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:17 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:15 msgid "" "There are only two _required_ fields in the **[project]** table: " "**name=** and **version=**." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:18 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:16 msgid "" "We suggest you add additional metadata to your `pyproject.toml` file as " "it will make it easier for users to find your project on PyPI." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:19 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:17 msgid "" "When you are adding classifiers to the [project] table, only use valid " "values from [PyPI’s classifier page](https://PyPI.org/classifiers/). An " @@ -2113,7 +2140,7 @@ msgid "" "publish to PyPI." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:20 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:18 msgid "" "There is no specific order for tables in the `pyproject.toml` file. " "However fields need to be placed within the correct table sections. For " @@ -2121,33 +2148,33 @@ msgid "" "system]** table." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:21 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:19 msgid "" "**python-requires**: is important to have in your `pyproject.toml` file " "as it helps pip install your package." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:27 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:24 msgid "when these are published, remove this todo" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:36 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:33 msgid "" "Need help creating your pyproject.toml file? This tutorial will walk you" " through the process." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:50 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:47 msgid "" "Click here if need help migrating from setup.py/setup.cfg to " "pyproject.toml" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:60 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:57 msgid "About the pyproject.toml file" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:62 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:59 msgid "" "Every modern Python package should include a `pyproject.toml` file. If " "your project is pure Python and you're using a `setup.py` or `setup.cfg` " @@ -2155,18 +2182,18 @@ msgid "" "metadata and build information to a `pyproject.toml` file." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:64 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:61 msgid "" "If your project isn’t pure-python, you might still require a `setup.py` " "file to build the non Python extensions. However, a `pyproject.toml` file" " should still be used to store your project’s metadata." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:66 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:63 msgid "What happened to setup.py & how do i migrate to pyproject.toml?" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:68 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:65 msgid "" "Prior to August 2017, Python package metadata was stored either in the " "`setup.py` file or a `setup.cfg` file. In recent years, there has been a " @@ -2174,11 +2201,11 @@ msgid "" "`pyproject.toml` format. Having all metadata in a single file:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:70 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:67 msgid "simplifies package management," msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:71 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:68 msgid "" "allows you to use a suite of different [build " "backends](https://www.pyopensci.org/python-package-guide/package-" @@ -2186,11 +2213,11 @@ msgid "" "(flit-core, hatchling, pdm-build), and" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:72 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:69 msgid "aligns with modern best practices." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:79 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:76 msgid "" "The standard file that Python packages use to [specify build requirements" " and metadata is called a " @@ -2200,11 +2227,11 @@ msgid "" "information in a setup.py or setup.cfg file." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:84 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:81 msgid "About the .toml format" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:86 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:83 msgid "" "The **pyproject.toml** file is written in [TOML (Tom's Obvious, Minimal " "Language) format](https://toml.io/en/). TOML is an easy-to-read structure" @@ -2214,26 +2241,25 @@ msgid "" "particular table." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:90 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:87 msgid "Below `[build-system]` is considered a table in the toml language." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:91 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:88 msgid "Within the `build-system` table below `requires =` is a key." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:92 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:89 msgid "" "The associated value for `requires` is an array containing the value " "`\"hatchling\"`." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:100 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:97 msgid "How the pyproject.toml is used when you build a package" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:104 -#: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:81 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:101 msgid "" "When you publish to PyPI, you will notice that each package has metadata " "listed. Let’s have a look at [xclim](https://pypi.org/project/xclim/), " @@ -2248,7 +2274,7 @@ msgid "" "on their website." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:106 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:103 #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:83 msgid "" "Image showing the left side bar of PyPI for the package xclim. The " @@ -2258,7 +2284,7 @@ msgid "" " those sections are various classifier options.\" width=\"300px\">" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:111 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:108 #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:88 msgid "" "When you add the classifier section to your pyproject.toml and your " @@ -2268,22 +2294,22 @@ msgid "" "python they support, categories and more." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:116 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:113 msgid "Benefits of using a pyproject.toml file" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:118 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:115 msgid "" "Including your package's metadata in a separate human-readable " "**pyproject.toml** format also allows someone to view the project's " "metadata in a GitHub repository." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:126 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:123 msgid "Setup.py is still useful for complex package builds" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:130 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:127 msgid "" "Using **setup.py** to manage package builds and metadata [can cause " "problems with package " @@ -2294,50 +2320,50 @@ msgid "" "the future." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:136 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:133 msgid "Optional vs. Required pyproject.toml file fields" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:138 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:135 msgid "" "When you create your `pyproject.toml` file, there are numerous metadata " "fields that you can use. Below we suggest specific fields to get you " "started that support publication on PyPI and users finding your package." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:140 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:137 msgid "" "[An overview of all of the project metadata elements can be found " "here.](https://packaging.python.org/en/latest/specifications/core-" "metadata/#project-url-multiple-use)" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:142 -msgid "Required fields for the [project] table" +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:139 +msgid "Required fields for the `[project]` table" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:144 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:141 msgid "" -"As mentioned above, your pyproject.toml file needs to have a **name** and" -" **version** field in order to properly build your package:" +"As mentioned above, your `pyproject.toml` file needs to have a **`name`**" +" and **`version`** field in order to properly build your package:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:146 -msgid "Name: This is the name of your project provided as a string" +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:143 +msgid "`name`: This is the name of your project provided as a string" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:147 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:144 msgid "" -"Version: This is the version of your project. If you are using a scm tool" -" for versioning (using git tags to determine versions), then the version " -"may be dynamic (more on that below)." +"`version`: This is the version of your project. If you are using a SCM " +"tool for versioning (using git tags to determine versions), then the " +"version may be dynamic (more on that below)." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:149 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:146 msgid "Optional fields to include in the `[project]` table" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:151 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:148 msgid "" "We strongly suggest that you also add the metadata keys below as they " "will help users finding your package on PyPI. These fields will make it " @@ -2345,50 +2371,50 @@ msgid "" " dependencies your package requires." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:156 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:153 msgid "**Description:** this is a short one-line description of your package." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:157 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:154 msgid "" "**Readme:** A link to your README.md file is used for the long long-" "description. This information will be published on your packages PyPI " "landing page." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:158 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:155 msgid "" "**Requires-python** (used by pip): this is a field that is used by pip. " "Here you tell the installer whether you are using Python 2.x or 3.x. Most" " projects will be using 3.x." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:159 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:156 msgid "**License:** the license you are using" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:160 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:157 msgid "" "**Authors:** these are the original authors of the package. Sometimes the" " authors are different from the maintainers. Other times they might be " "the same." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:161 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:158 msgid "" "**Maintainers:** you can choose to populate this or not. You can populate" " this using a list with a sub element for each author or maintainer name," " email" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:169 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:166 msgid "" "**dependencies:** dependencies are optional but we strongly suggest you " "include them in your pyproject.toml. Dependencies will be installed by " "pip when your project is installed creating a better user-experience." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:171 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:168 msgid "" "**`[project.optional-dependencies]`:** the optional or development " "dependencies will be installed if someone runs `python -m pip install " @@ -2396,14 +2422,14 @@ msgid "" "dependencies for users who may wish to contribute to your project." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:173 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:170 msgid "" "**keywords:** These are the keywords that will appear on your PyPI " "landing page. Think of them as words that people might use to search for " "your package." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:174 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:171 msgid "" "**classifiers:** The classifiers section of your metadata is also " "important for the landing page of your package in PyPI and for filtering " @@ -2412,35 +2438,35 @@ msgid "" "should consider including" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:175 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:172 msgid "Development Status" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:176 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:173 msgid "Intended Audience" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:177 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:174 msgid "Topic" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:178 -msgid "LIcense" +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:175 +msgid "License" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:179 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:176 msgid "Programming language" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:181 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:178 msgid "Advanced options in the pyproject.toml file" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:183 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:180 msgid "The examples at the bottom of this page contain ..." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:185 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:182 msgid "" "**`[project.scripts]` (Entry points):** Entry points are optional. If you" " have a command line tool that runs a specific script hosted in your " @@ -2448,29 +2474,29 @@ msgid "" "the command line (rather than at the Python shell)." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:186 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:184 msgid "" -"Here is an example of[ a package that has entry point " -"script](https://github.com/pyOpenSci/update-web-" -"metadata/blob/main/pyproject.toml#L60)s. Notice that there are several " -"core scripts defined in that package that perform sets of tasks. " -"pyOpenSci is using those scripts to process their metadata." +"Here is an example of[a package that has entry point " +"script](https://github.com/pyOpenSci/pyosMeta/blob/main/pyproject.toml#L60)s." +" Notice that there are several core scripts defined in that package that " +"perform sets of tasks. The pyOpenSci is using those scripts to process " +"their metadata." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:187 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:185 msgid "" "**Dynamic Fields:** if you have fields that are dynamically populated. " "One example of this is if you are using scm / version control based " "version with tools like `setuptooms_scm`, then you might use the dynamic " -"field. such as version (using scm) **dynamic = [\"version\"]**" +"field, such as version (using scm) **dynamic = [\"version\"]**" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:189 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:187 #: ../../package-structure-code/python-package-build-tools.md:392 msgid "Add dependencies to your pyproject.toml file" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:191 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:189 msgid "" "The pyproject.toml file can also be used as a replacement for the " "requirements.txt file which has been traditionally used to store " @@ -2478,70 +2504,70 @@ msgid "" "and documentation tools such as sphinx." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:193 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:191 msgid "" "To add dependencies to your build, add a `[project.optional-" "dependencies]` table to your pyproject.toml file." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:195 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:193 msgid "Then specify dependency groups as follows:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:202 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:200 msgid "Following the above example, you install dependencies like this:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:204 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:202 msgid "`python -m pip install -e .[tests]`" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:206 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:204 msgid "" "The above will install both your package in editable mode and all of the " "dependencies declared in the tests section of your `[project.optional-" "dependencies]` table." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:208 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:206 msgid "To install all dependencies and also your package, you'd use:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:210 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:208 msgid "`python -m pip install -e .[tests,lint,docs]`" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:212 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:210 msgid "Recursive dependencies" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:216 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:214 msgid "" "You can also setup sets of recursive dependencies. [See this blog post " "for more.](https://hynek.me/articles/python-recursive-optional-" "dependencies/)" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:219 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:217 msgid "Example pyproject.toml for building using hatchling" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:221 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:219 msgid "" "Below is an example build configuration for a Python project. This " "example package setup uses **hatchling** to build the [package's sdist " "and wheels](python-package-distribution-files-sdist-wheel)." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:229 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:227 msgid "Notice that dependencies are specified in this file." msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:231 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:229 msgid "Example pyproject.toml for building using setuptools" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:233 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:231 msgid "" "The package metadata including authors, keywords, etc is also easy to " "read. Below you can see the same TOML file that uses a different build " @@ -2549,37 +2575,37 @@ msgid "" " to build this package!" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:237 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:235 msgid "In this example package setup you use:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:239 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:237 msgid "" "**setuptools** to build the [package's sdist and wheels](python-package-" "distribution-files-sdist-wheel)" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:240 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:238 msgid "" "**setuptools_scm** to manage package version updates using version " "control tags" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:242 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:240 msgid "" "In the example below `[build-system]` is the first table of values. It " "has two keys that specify the build backend API and containing package:" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:245 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:243 msgid "`requires =`" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:246 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:244 msgid "`build-back-end =`" msgstr "" -#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:253 +#: ../../package-structure-code/pyproject-toml-python-package-metadata.md:251 msgid "" "[Click here to read about our packaging build tools including PDM, " "setuptools, Poetry and Hatch.](/package-structure-code/python-package-" @@ -3913,9 +3939,9 @@ msgstr "" msgid "" "Once you have published both package distributions (the source " "distribution and the wheel) to PyPI, you can then publish to conda-forge." -" conda-forge requires an source distribution on PyPI in order to build " -"your package on conda-forge. You do not need to rebuild your package to " -"publish to conda-forge." +" The conda-forge requires an source distribution on PyPI in order to " +"build your package on conda-forge. You do not need to rebuild your " +"package to publish to conda-forge." msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:11 @@ -4030,14 +4056,29 @@ msgstr "" msgid "An example - xclim" msgstr "" +#: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:81 +msgid "" +"When you publish to PyPI, you will notice that each package has metadata " +"listed. Let's have a look at [xclim](https://pypi.org/project/xclim/), " +"one of our [pyOpenSci packages](https://www.pyopensci.org/python-" +"packages.html). Notice that on the PyPI landing page you see some " +"metadata about the package including python, maintainer information and " +"more. PyPI is able to populate this metadata because it was defined using" +" correct syntax and classifiers by Xclim's maintainers, [pyproject.toml " +"file](https://github.com/Ouranosinc/xclim/blob/master/pyproject.toml). " +"This metadata when the xclim package is built, is translated into a " +"distribution file that allows PyPI to read the metadata and print it out " +"on their website." +msgstr "" + #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:94 msgid "" "Graphic showing the high level packaging workflow. On the left you see a " -"graphic with code, metadata and tests in it. those items all go into your" +"graphic with code, metadata and tests in it. Those items all go into your" " package. Documentation and data are below that box because they aren't " -"normally published in your packaging wheel distribution. an arrow to the " -"right takes you to a build distribution files box. that box leads you to " -"either publishing to TestPyPI or the real PyPI. from PyPI you can then " +"normally published in your packaging wheel distribution. An arrow to the " +"right takes you to a build distribution files box. That box leads you to " +"either publishing to TestPyPI or the real PyPI. From PyPI you can then " "connect to conda-forge for an automated build that sends distributions " "from PyPI to conda-forge." msgstr "" @@ -4054,7 +4095,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:101 msgid "" -"This screenshot shows the metadata on PyPI for the xclim package. on it " +"This screenshot shows the metadata on PyPI for the xclim package. On it " "you can see the name of the license, the author and maintainer names " "keywords associated with the package and the base python version it " "requires which is 3.8." @@ -4066,7 +4107,7 @@ msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:110 msgid "" -"Here you see the maintinaer metadata as it is displayed on PyPI. for " +"Here you see the maintainer metadata as it is displayed on PyPI. For " "xclim there are three maintainers listed with their profile pictures and " "github user names to the right." msgstr "" @@ -4147,7 +4188,7 @@ msgid "" msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:155 -msgid "Source Distribution (sdist)" +msgid "What is a source distribution (sdist)" msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:157 @@ -4194,7 +4235,7 @@ msgid "" msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:229 -msgid "Wheel (.whl files):" +msgid "What is a Python wheel (whl):" msgstr "" #: ../../package-structure-code/python-package-distribution-files-sdist-wheel.md:231 @@ -4288,18 +4329,16 @@ msgstr "" #: ../../package-structure-code/python-package-structure.md:3 msgid "" "There are two different layouts that you will commonly see within the " -"Python packaging ecosystem: [src and flat " -"layouts.](https://packaging.python.org/en/latest/discussions/src-layout-" -"vs-flat-layout/) Both layouts have advantages for different groups of " -"maintainers." +"Python packaging ecosystem: src and flat layouts. Both layouts have " +"advantages for different groups of maintainers." msgstr "" #: ../../package-structure-code/python-package-structure.md:8 msgid "" "We strongly suggest, but do not require, that you use the **src/** layout" " (discussed below) for creating your Python package. This layout is also " -"recommended in the [PyPA packaging " -"guide](https://packaging.python.org/en/latest/tutorials/packaging-" +"recommended in the [PyPA packaging guide " +"tutorial](https://packaging.python.org/en/latest/tutorials/packaging-" "projects/)." msgstr "" @@ -4309,8 +4348,8 @@ msgstr "" #: ../../package-structure-code/python-package-structure.md:15 msgid "" -"We understand that it would be tremendous effort for existing maintainers" -" to move to a new layout." +"We understand that it would take significant effort for existing " +"maintainers to move to a new layout." msgstr "" #: ../../package-structure-code/python-package-structure.md:18 @@ -4321,134 +4360,154 @@ msgid "" "proof approach." msgstr "" +#: ../../package-structure-code/python-package-structure.md:22 +msgid "Other resources you can check out:" +msgstr "" + #: ../../package-structure-code/python-package-structure.md:23 -msgid "An example of the **src/package** layout structure can be seen below." +msgid "" +"[PyPA's overview of src vs flat " +"layouts](https://packaging.python.org/en/latest/discussions/src-layout-" +"vs-flat-layout/)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:45 +#: ../../package-structure-code/python-package-structure.md:26 +msgid "" +"You can use tools like Hatch to quickly create a modern Python package " +"structure. Check out our quickstart tutorial:" +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:29 +msgid "" +"Want to learn how to create the structure to build your package? Click " +"here." +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:37 +msgid "What is the Python package source layout?" +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:39 +msgid "An example of the **src/package** layout structure is below." +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:61 msgid "Note the location of the following directories in the example above:" msgstr "" -#: ../../package-structure-code/python-package-structure.md:47 +#: ../../package-structure-code/python-package-structure.md:63 msgid "" -"**docs/:** discussed in our docs chapter, this directory contains your " +"**docs/:** Discussed in our docs chapter, this directory contains your " "user-facing documentation website. In a **src/** layout docs/ are " -"normally included at the same directory level of the **src/** folder." +"normally included at the same directory level as the **src/** folder." msgstr "" -#: ../../package-structure-code/python-package-structure.md:48 +#: ../../package-structure-code/python-package-structure.md:64 msgid "" -"**tests/** this directory contains the tests for your project code. In a " -"**src/** layout tests are normally included at the same directory level " -"of the **src/** folder." +"**tests/** This directory contains the tests for your project code. In a " +"**src/** layout, tests are normally included at the same directory level " +"as the **src/** folder." msgstr "" -#: ../../package-structure-code/python-package-structure.md:49 +#: ../../package-structure-code/python-package-structure.md:65 msgid "" "**src/package/**: this is the directory that contains the code for your " "Python project. \"Package\" is normally your project's name." msgstr "" -#: ../../package-structure-code/python-package-structure.md:51 +#: ../../package-structure-code/python-package-structure.md:67 msgid "" "Also in the above example, notice that all of the core documentation " "files that pyOpenSci requires live in the root of your project directory." " These files include:" msgstr "" -#: ../../package-structure-code/python-package-structure.md:55 +#: ../../package-structure-code/python-package-structure.md:71 msgid "CHANGELOG.md" msgstr "" -#: ../../package-structure-code/python-package-structure.md:56 +#: ../../package-structure-code/python-package-structure.md:72 msgid "CODE_OF_CONDUCT.md" msgstr "" -#: ../../package-structure-code/python-package-structure.md:57 +#: ../../package-structure-code/python-package-structure.md:73 msgid "CONTRIBUTING.md" msgstr "" -#: ../../package-structure-code/python-package-structure.md:58 +#: ../../package-structure-code/python-package-structure.md:74 msgid "LICENSE.txt" msgstr "" -#: ../../package-structure-code/python-package-structure.md:59 +#: ../../package-structure-code/python-package-structure.md:75 msgid "README.md" msgstr "" -#: ../../package-structure-code/python-package-structure.md:63 +#: ../../package-structure-code/python-package-structure.md:79 msgid "Click here to read about our packaging documentation requirements." msgstr "" -#: ../../package-structure-code/python-package-structure.md:70 -msgid "" -"While we recommend the **src/** layout we also review the **flat** layout" -" here. Both are used in the Python ecosystem." -msgstr "" - -#: ../../package-structure-code/python-package-structure.md:72 +#: ../../package-structure-code/python-package-structure.md:86 msgid "Example scientific packages that use **src/package** layout" msgstr "" -#: ../../package-structure-code/python-package-structure.md:74 +#: ../../package-structure-code/python-package-structure.md:88 msgid "[Sourmash](https://github.com/sourmash-bio/sourmash)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:75 +#: ../../package-structure-code/python-package-structure.md:89 msgid "[bokeh](https://github.com/bokeh/bokeh)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:76 +#: ../../package-structure-code/python-package-structure.md:90 msgid "[openscm](https://github.com/openscm/openscm-runner)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:77 +#: ../../package-structure-code/python-package-structure.md:91 msgid "[awkward](https://github.com/scikit-hep/awkward)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:78 +#: ../../package-structure-code/python-package-structure.md:92 msgid "[poliastro](https://github.com/poliastro/poliastro/)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:82 +#: ../../package-structure-code/python-package-structure.md:96 msgid "The src/ layout and testing" msgstr "" -#: ../../package-structure-code/python-package-structure.md:84 +#: ../../package-structure-code/python-package-structure.md:98 msgid "" -"The benefit of using the **src/package** layout, particularly if you are " -"creating a new package, is that it ensures tests are run against the " -"installed version of your package rather than the files in your package " -"working directory. If you run your tests on your files rather than the " -"installed version, you may be missing issues that users encounter when " -"your package is installed." +"The benefit of using the **src/package** layout is that it ensures tests " +"are run against the installed version of your package rather than the " +"files in your package working directory. If you run your tests on your " +"files rather than the installed version of your package, you may be " +"missing issues that users encounter when your package is installed." msgstr "" -#: ../../package-structure-code/python-package-structure.md:91 +#: ../../package-structure-code/python-package-structure.md:104 msgid "" -"If `tests/` are outside of the **src/package** directory, they aren't " -"included in the package wheel. This makes your package size slightly " -"smaller which then places places a smaller storage burden on PyPI which " -"has over 400,000 packages to support." +"If `tests/` are outside the **src/package** directory, they aren't " +"included in the package's [wheel](python-wheel). This makes your package " +"size slightly smaller, which places a smaller storage burden on PyPI, and" +" makes them faster to fetch." msgstr "" -#: ../../package-structure-code/python-package-structure.md:93 +#: ../../package-structure-code/python-package-structure.md:106 msgid "" "[Read more about reasons to use the **src/package** " "layout](https://hynek.me/articles/testing-packaging/)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:95 +#: ../../package-structure-code/python-package-structure.md:108 msgid "How Python discovers and prioritizes importing modules" msgstr "" -#: ../../package-structure-code/python-package-structure.md:97 +#: ../../package-structure-code/python-package-structure.md:110 msgid "" "By default, Python adds a module in your current working directory to the" " front of the Python module search path." msgstr "" -#: ../../package-structure-code/python-package-structure.md:99 +#: ../../package-structure-code/python-package-structure.md:112 msgid "" "This means that if you run your tests in your package's working " "directory, using a flat layout, `/package/module.py`, Python will " @@ -4456,44 +4515,46 @@ msgid "" "package." msgstr "" -#: ../../package-structure-code/python-package-structure.md:101 +#: ../../package-structure-code/python-package-structure.md:114 msgid "" "However, if your package lives in a src/ directory structure " -"**src/package** then it won't be, by default, added to the Python path. " -"This means that when you import your package, Python will be forced to " +"**src/package**, then it won't be added to the Python path by default. " +"This means that when you import your package, Python will be forced to " "search the active environment (which has your package installed)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:103 +#: ../../package-structure-code/python-package-structure.md:116 msgid "" "Note: Python versions 3.11 and above have a path setting that can be " -"adjusted to ensure the priority is to use installed packages first (e.g. " -"`PYTHONSAFEPATH`)." +"adjusted to ensure the priority is to use installed packages first (e.g.," +" `PYTHONSAFEPATH`)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:106 -msgid "Sometimes tests are needed in a distribution" +#: ../../package-structure-code/python-package-structure.md:119 +msgid "Don't include tests in your package wheel" msgstr "" -#: ../../package-structure-code/python-package-structure.md:108 +#: ../../package-structure-code/python-package-structure.md:121 msgid "" -"We do not recommend including tests as part of your package wheel by " -"default. However, not including tests in your package distribution will " -"make it harder for people other than yourself to test whether your " -"package is functioning correctly on their system. If you have a small " +"Writing [tests](tests-intro) for your package is important; however, we " +"do not recommend including tests as part of your [package wheel](python-" +"wheel) by default. However, not including tests in your package " +"distribution will make it harder for people other than yourself to test " +"whether your package runs properly on their system. If you have a small " "test suite (Python files + data), and think your users may want to run " "tests locally on their systems, you can include tests by moving the " "`tests/` directory into the **src/package** directory (see example " "below)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:117 +#: ../../package-structure-code/python-package-structure.md:130 msgid "" "Including the **tests/** directory in your **src/package** directory " -"ensures that tests will be included in your package's wheel." +"ensures that tests will be included in your package's [wheel](python-" +"wheel)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:119 +#: ../../package-structure-code/python-package-structure.md:132 msgid "" "Be sure to read the [pytest documentation for more about including tests " "in your package " @@ -4501,162 +4562,166 @@ msgid "" "-test-layout-import-rules)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:121 +#: ../../package-structure-code/python-package-structure.md:134 msgid "Challenges with including tests and data in a package wheel" msgstr "" -#: ../../package-structure-code/python-package-structure.md:124 +#: ../../package-structure-code/python-package-structure.md:137 msgid "" -"Tests, especially when accompanied by test data can create a few small " -"challenges including:" +"Tests, especially when accompanied by test data, can create a few small " +"challenges, including:" msgstr "" -#: ../../package-structure-code/python-package-structure.md:126 +#: ../../package-structure-code/python-package-structure.md:139 msgid "" -"Take up space in your distribution which will build up over time as " +"Take up space in your distribution, which will build up over time as " "storage space on PyPI" msgstr "" -#: ../../package-structure-code/python-package-structure.md:127 -msgid "Large file sizes can also slow down package install." +#: ../../package-structure-code/python-package-structure.md:140 +msgid "Large file sizes can also slow down package installation." msgstr "" -#: ../../package-structure-code/python-package-structure.md:129 +#: ../../package-structure-code/python-package-structure.md:142 msgid "" -"However, in some cases, particularly in the scientific Python ecosystems " +"However, in some cases, particularly in the scientific Python ecosystem, " "you may need to include tests." msgstr "" -#: ../../package-structure-code/python-package-structure.md:132 +#: ../../package-structure-code/python-package-structure.md:145 msgid "**Don't include test suite datasets in your package**" msgstr "" -#: ../../package-structure-code/python-package-structure.md:134 +#: ../../package-structure-code/python-package-structure.md:147 msgid "" -"If you do include your tests in your package distribution, we strongly " +"If you include your tests in your package distribution, we strongly " "discourage you from including data in your test suite directory. Rather, " "host your test data in a repository such as Figshare or Zenodo. Use a " "tool such as [Pooch](https://www.fatiando.org/pooch/latest/) to access " "the data when you (or a user) runs tests." msgstr "" -#: ../../package-structure-code/python-package-structure.md:140 +#: ../../package-structure-code/python-package-structure.md:153 msgid "" -"Check out the testing section of our guide for more information about " -"tests." +"For more information about Python package tests, see the [tests section " +"of our guide](tests-intro)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:142 +#: ../../package-structure-code/python-package-structure.md:155 msgid "" "The **src/package** layout is semantically more clear. Code is always " "found in the **src/package** directory, `tests/` and `docs/`are in the " "root directory." msgstr "" -#: ../../package-structure-code/python-package-structure.md:146 +#: ../../package-structure-code/python-package-structure.md:159 msgid "" -"If your package tests require data, we suggest that you do NOT include " -"that data within your package structure. We will discuss this in more " -"detail in a tutorial. Include data in your package structure increases " -"the size of your distribution files. This places a maintenance toll on " +"If your package tests require data, do NOT include that data within your " +"package structure. Including data in your package structure increases the" +" size of your distribution files. This places a maintenance toll on " "repositories like PyPI and Anaconda.org that have to deal with thousands " "of package uploads." msgstr "" -#: ../../package-structure-code/python-package-structure.md:153 -msgid "About the flat Python package layout" +#: ../../package-structure-code/python-package-structure.md:166 +msgid "Click here for a quickstart tutorial on creating your Python package." msgstr "" -#: ../../package-structure-code/python-package-structure.md:155 -msgid "Currently most scientific packages use the **flat-layout** given:" +#: ../../package-structure-code/python-package-structure.md:176 +msgid "What is the flat Python package layout?" msgstr "" -#: ../../package-structure-code/python-package-structure.md:157 +#: ../../package-structure-code/python-package-structure.md:178 +msgid "Many scientific packages use the **flat-layout** given:" +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:180 msgid "" -"It's the most commonly found layout with the scientific Python ecosystem " -"and people tend to look to other packages / maintainers that they respect" -" for examples of how to build Python packages." +"This layout is used by many core scientific Python packages such as " +"NumPy, SciPy, and Matplotlib." msgstr "" -#: ../../package-structure-code/python-package-structure.md:160 +#: ../../package-structure-code/python-package-structure.md:181 msgid "" -"Many Python tools depend upon tools in other language and / or complex " -"builds with compilation steps. Many developers thus appreciate / are used" -" to features of the flat layout." +"Many Python tools depend upon tools in other languages and/or complex " +"builds with compilation steps. Many maintainers prefer features of the " +"flat layout for more complex builds." msgstr "" -#: ../../package-structure-code/python-package-structure.md:164 +#: ../../package-structure-code/python-package-structure.md:185 msgid "" -"While we present this layout here in our guide, we suggest that those " -"just getting started with python packaging start with the src/package " -"layout discussed above. Numerous packages in the ecosystem [have had to " -"move to a src/ layout](https://github.com/scikit-build/cmake-python-" -"distributions/pull/145)" +"While we suggest that you use the **src/package** layout discussed above," +" it's important to also understand the flat layout, especially if you " +"plan to contribute to a package that uses this layout." msgstr "" -#: ../../package-structure-code/python-package-structure.md:169 +#: ../../package-structure-code/python-package-structure.md:189 msgid "Why most scientific Python packages do not use source" msgstr "" -#: ../../package-structure-code/python-package-structure.md:172 +#: ../../package-structure-code/python-package-structure.md:192 msgid "" -"In most cases the advantages of using the **src/package** layout for " -"larger scientific packages that already use flat approach are not worth " -"it. Moving from a flat layout to a **src/package** layout would come at a" -" significant cost to maintainers." +"In most cases, moving to the **src/package** layout for larger scientific" +" packages that already use a flat layout would consume significant time." msgstr "" -#: ../../package-structure-code/python-package-structure.md:177 +#: ../../package-structure-code/python-package-structure.md:195 msgid "" "However, the advantages of using the **src/package** layout for a " -"beginner are significant. As such, we recommend that if you are getting " -"started with creating a package, that you consider using a " -"**src/package** layout." +"beginner are significant. As such, we recommend that you use the " +"**src/package** layout if you are creating a new package." +msgstr "" + +#: ../../package-structure-code/python-package-structure.md:198 +msgid "" +"Numerous packages in the ecosystem [have had to move to a **src/package**" +" layout](https://github.com/scikit-build/cmake-python-" +"distributions/pull/145)." msgstr "" -#: ../../package-structure-code/python-package-structure.md:182 +#: ../../package-structure-code/python-package-structure.md:202 msgid "What does the flat layout structure look like?" msgstr "" -#: ../../package-structure-code/python-package-structure.md:184 +#: ../../package-structure-code/python-package-structure.md:204 msgid "The flat layout's primary characteristics are:" msgstr "" -#: ../../package-structure-code/python-package-structure.md:186 +#: ../../package-structure-code/python-package-structure.md:206 msgid "" "The source code for your package lives in a directory with your package's" " name in the root of your directory" msgstr "" -#: ../../package-structure-code/python-package-structure.md:188 +#: ../../package-structure-code/python-package-structure.md:208 msgid "" "Often the `tests/` directory also lives within that same `package` " "directory." msgstr "" -#: ../../package-structure-code/python-package-structure.md:190 +#: ../../package-structure-code/python-package-structure.md:210 msgid "" "Below you can see the recommended structure of a scientific Python " "package using the flat layout." msgstr "" -#: ../../package-structure-code/python-package-structure.md:212 +#: ../../package-structure-code/python-package-structure.md:232 msgid "Benefits of using the flat layout in your Python package" msgstr "" -#: ../../package-structure-code/python-package-structure.md:214 +#: ../../package-structure-code/python-package-structure.md:234 msgid "" "There are some benefits to the scientific community in using the flat " "layout." msgstr "" -#: ../../package-structure-code/python-package-structure.md:216 +#: ../../package-structure-code/python-package-structure.md:236 msgid "" "This structure has historically been used across the ecosystem and " "packages using it are unlikely to change." msgstr "" -#: ../../package-structure-code/python-package-structure.md:218 +#: ../../package-structure-code/python-package-structure.md:238 msgid "" "You can import the package directly from the root directory. For some " "this is engrained in their respective workflows. However, for a beginner " @@ -4665,43 +4730,43 @@ msgid "" "directly with the flat files." msgstr "" -#: ../../package-structure-code/python-package-structure.md:224 +#: ../../package-structure-code/python-package-structure.md:244 msgid "Core scientific Python packages that use the flat layout" msgstr "" -#: ../../package-structure-code/python-package-structure.md:227 +#: ../../package-structure-code/python-package-structure.md:247 msgid "[numpy](https://github.com/numpy/numpy)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:228 +#: ../../package-structure-code/python-package-structure.md:248 msgid "[scipy](https://github.com/scipy/scipy)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:229 +#: ../../package-structure-code/python-package-structure.md:249 msgid "[pandas](https://github.com/pandas-dev/pandas)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:230 +#: ../../package-structure-code/python-package-structure.md:250 msgid "[xarray](https://github.com/pydata/xarray)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:231 +#: ../../package-structure-code/python-package-structure.md:251 msgid "[Jupyter-core](https://github.com/jupyter/jupyter_core)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:232 +#: ../../package-structure-code/python-package-structure.md:252 msgid "[Jupyter notebook](https://github.com/jupyter/notebook)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:233 +#: ../../package-structure-code/python-package-structure.md:253 msgid "[scikit-learn](https://github.com/scikit-learn/scikit-learn)" msgstr "" -#: ../../package-structure-code/python-package-structure.md:235 +#: ../../package-structure-code/python-package-structure.md:255 msgid "" "It would be a significant maintenance cost and burden to move all of " "these packages to a different layout. The potential benefits of the " -"source layout for these tools is not worth the maintenance investment." +"source layout for these tools are not worth the maintenance investment." msgstr "" #: ../../package-structure-code/python-package-versions.md:1 @@ -4770,7 +4835,7 @@ msgstr "" msgid "" "Consistent version increases following semver rules mean that values of " "your package version explain the extent of the changes made in the code " -"base from version to version. thus your package version numbers become " +"base from version to version. Thus your package version numbers become " "\"expressive\" in the same way that naming code variables well can [make " "code expressive](https://medium.com/@daniel.oliver.king/writing-" "expressive-code-b69ef7a5a2fa)." @@ -4934,7 +4999,7 @@ msgstr "" #: ../../package-structure-code/python-package-versions.md:107 msgid "" "Generally semantic release and version control system tools can be setup " -"to run automatically on GitHub using GitHub actions. This means that you " +"to run automatically on GitHub using GitHub Actions. This means that you " "can create a workflow where a GitHub release and associated new version " "tag is used to trigger an automated build that:" msgstr "" @@ -4955,7 +5020,7 @@ msgstr "" msgid "" "Bumping a package version refers to the step of increasing the package " "version after a set number of changes have been made to it. For example, " -"you might bump from version 0.8 to 0.9 of a package. or from 0.9 to 1.0." +"you might bump from version 0.8 to 0.9 of a package or from 0.9 to 1.0." msgstr "" #: ../../package-structure-code/python-package-versions.md:122 @@ -5065,7 +5130,7 @@ msgstr "" #: ../../package-structure-code/python-package-versions.md:173 msgid "" "When you (or your CI system) build your package, hatch checks the current" -" tag number for your package. if it has increased, it will update the " +" tag number for your package. If it has increased, it will update the " "**\\_version.py** file with the new value." msgstr "" @@ -5299,3 +5364,683 @@ msgid "" "The version number is manually updated in a configuration file such as " "`pyproject.toml` vs. in a package **\\_version.py** file." msgstr "" + +#~ msgid "" +#~ "The pre-commit workflow begins with " +#~ "you adding files that have changes " +#~ "to be staged in git. Next, you'd" +#~ " run git commit. when you run " +#~ "git commit, the pre-commit hooks " +#~ "will then run. In this example, " +#~ "Black, the code formatter and flake8," +#~ " a linter both run. If all of" +#~ " the files pass Black and flake8 " +#~ "checks, then your commit will be " +#~ "recorded. If they don't, the commit " +#~ "is canceled. You will have to fix" +#~ " any flake8 issues, and then re-" +#~ "add / stage the files to be " +#~ "committed. [_Image " +#~ "Source_](https://ljvmiranda921.github.io/notebook/2018/06/21" +#~ "/precommits-using-black-and-flake8/*)" +#~ msgstr "" + +#~ msgid "" +#~ "In addition to calling tools, Pre-" +#~ "commit also has a suite of [built" +#~ " in format hooks](https://github.com/pre-commit" +#~ "/pre-commit-hooks#hooks-available) that you" +#~ " can call. Some, such as trailing-" +#~ "whitespace can be also useful to " +#~ "add to your pre-commit workflow to" +#~ " ensure clean, streamlined code files." +#~ msgstr "" + +#~ msgid "" +#~ "**Python packages that have extensions " +#~ "written in different languages (e.g. " +#~ "Fortran and C++) or that have non" +#~ " Python dependencies that are difficult " +#~ "to install (e.g. GDAL)** These packages" +#~ " often have complex build steps (more" +#~ " complex than a package with just " +#~ "a few C extensions for instance). " +#~ "As such, these packages require tools" +#~ " such as [scikit-build](https://scikit-" +#~ "build.readthedocs.io/en/latest/) or [meson-" +#~ "python](https://mesonbuild.com/Python-module.html) to " +#~ "build. NOTE: you can use meson-" +#~ "python with PDM." +#~ msgstr "" + +#~ msgid "" +#~ "keep this comment - " +#~ "https://github.com/pyOpenSci/python-package-" +#~ "guide/pull/106#issuecomment-1844278487 in this file" +#~ " for now - jeremiah did a nice" +#~ " inventory of common shells and " +#~ "whether they need quotes or not. " +#~ "it's really comprehensive. but do we " +#~ "want it in the guide?? it's really" +#~ " useful for more advanced users i " +#~ "think." +#~ msgstr "" + +#~ msgid "needs to function properly." +#~ msgstr "" + +#~ msgid "" +#~ "requires if someone wants to develop " +#~ "/ work on improving your package " +#~ "locally or" +#~ msgstr "" + +#~ msgid "" +#~ "requires if a user wants to add" +#~ " additional functionality (that is not " +#~ "core) to your package" +#~ msgstr "" + +#~ msgid "" +#~ "You can think about dependencies as " +#~ "being either optional or required. If" +#~ " they are required, they will be " +#~ "listed in the `[dependency] =` table " +#~ "of your `pyproject.toml` file. If they" +#~ " are optional, they will be listed" +#~ " in the `[optional.dependencies]` table of" +#~ " your `pyproject.toml`." +#~ msgstr "" + +#~ msgid "" +#~ "Required dependencies are called directly " +#~ "within your package's code. On this " +#~ "page we refer to these dependencies " +#~ "as **core dependencies** as they are " +#~ "needed in order to run your " +#~ "package. You should place your core " +#~ "or required dependencies in the " +#~ "`[dependency]=` table of your `pyproject.toml`" +#~ " file." +#~ msgstr "" + +#~ msgid "" +#~ "Ideally, you should only list the " +#~ "packages that are necessary to install" +#~ " and use your package in the " +#~ "`[dependencies]` section. This minimizes the" +#~ " number of additional packages that " +#~ "your users must install as well as" +#~ " the number of packages that depend" +#~ " upon your package must also install." +#~ msgstr "" + +#~ msgid "" +#~ "These dependencies are considered optional," +#~ " because they are not required to " +#~ "install and use your package. Feature" +#~ " dependencies are considered optional and" +#~ " should also be placed in the " +#~ "`[optional.dependencies]` table." +#~ msgstr "" + +#~ msgid "" +#~ "Optional dependencies can be stored in" +#~ " an `[optional.dependencies]` table in your" +#~ " **pyproject.toml** file." +#~ msgstr "" + +#~ msgid "" +#~ "It's important to note that within " +#~ "the `[optional.dependencies]` table, you can" +#~ " store additional, optional dependencies " +#~ "within named sub-groups. This is a" +#~ " different table than the dependencies " +#~ "array located within the `[project]` " +#~ "table discussed above which contains a" +#~ " single array with a single list " +#~ "of required packages." +#~ msgstr "" + +#~ msgid "Add a `[optional.dependencies]` table to your **pyproject.toml** file." +#~ msgstr "" + +#~ msgid "" +#~ "Diagram showing a ven diagram with " +#~ "three sections representing the dependency " +#~ "groups listed above - docs feature " +#~ "and tests. In the center it says" +#~ " your-package and lists the core " +#~ "dependencies of that package seaborn and" +#~ " numpy. To the right are two " +#~ "arrows. The first shows the command " +#~ "python - m pip install your-" +#~ "package. it them shows how installing" +#~ " your package that way installs only" +#~ " the package and the two core " +#~ "dependencies into a users environment. " +#~ "Below is a second arrow with " +#~ "python -m pip install youPackage[tests]. " +#~ "This leads to an environment with " +#~ "both the package dependencies - your-" +#~ "package, seaborn and numpy and also " +#~ "the tests dependencies including pytest " +#~ "and pytest-cov" +#~ msgstr "" + +#~ msgid "" +#~ "When a user installs your package " +#~ "locally using python -m pip install " +#~ "your-package only your package and " +#~ "it's core dependencies get installed. " +#~ "When they install your package `[tests]`" +#~ " pip will install both your package" +#~ " and its core dependencies plus any" +#~ " of the dependencies listed within " +#~ "the tests array of your " +#~ "`[optional.dependencies]` table." +#~ msgstr "" + +#~ msgid "required package dependencies in the `dependency` array and" +#~ msgstr "" + +#~ msgid "" +#~ "You can install multiple dependency " +#~ "groups in the `[optional.dependencies]` table" +#~ " using:" +#~ msgstr "" + +#~ msgid "Package structure & code style" +#~ msgstr "" + +#~ msgid "Publishing a package" +#~ msgstr "" + +#~ msgid "Python package structure information" +#~ msgstr "" + +#~ msgid "" +#~ "This section provides guidance on your" +#~ " Python package's structure, code formats" +#~ " and style. It also reviews the " +#~ "various packaging tools that you can " +#~ "use to support building and publishing" +#~ " your package." +#~ msgstr "" + +#~ msgid "" +#~ "If you are confused by Python " +#~ "packaging, you are not alone! The " +#~ "good news is there are some great" +#~ " modern packaging tools that ensure " +#~ "that you're following best practices. " +#~ "Here, we review tool features and " +#~ "suggest tools that might be best " +#~ "fitted for your workflow." +#~ msgstr "" + +#~ msgid "" +#~ "Provide an overview of the options " +#~ "available to you when packaging your " +#~ "tool." +#~ msgstr "" + +#~ msgid "" +#~ "Suggest tools and approaches that will" +#~ " allow you to expand upon a " +#~ "workflow that may begin as a pure" +#~ " Python tool and evolve into a " +#~ "tool that requires addition layers of" +#~ " complexity in the packaging build." +#~ msgstr "" + +#~ msgid "" +#~ "Image showing the progression of " +#~ "creating a Python package, building it" +#~ " and then publishing to PyPI and " +#~ "conda-forge. You take your code " +#~ "and turn it into distribution files " +#~ "(sdist and wheel) that PyPI accepts. " +#~ "then there is an arrow towards the" +#~ " PyPI repository where ou publish " +#~ "both distributions. From PyPI if you " +#~ "create a conda-forge recipe you " +#~ "can then publish to conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "Once you have published both package " +#~ "distributions (the source distribution and " +#~ "the wheel) to PyPI, you can then" +#~ " publish to conda-forge. conda-forge" +#~ " requires a source distribution on " +#~ "PyPI in order to build your " +#~ "package on conda-forge. You do not" +#~ " need to rebuild your package to " +#~ "publish to conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "[**conda-forge:**](https://anaconda.org/conda-forge) " +#~ "this is a community-driven channel " +#~ "that focuses on scientific packages. " +#~ "This channel is ideal for tools " +#~ "that support geospatial data. Anyone can" +#~ " publish a package to this channel." +#~ msgstr "" + +#~ msgid "" +#~ "[**bioconda**](https://anaconda.org/bioconda): this " +#~ "channel focuses on biomedical tools." +#~ msgstr "" + +#~ msgid "" +#~ "Graphic with the title Python package" +#~ " repositories. Below it says Anything " +#~ "hosted on PyPI can be installed " +#~ "using pip install. Packaging hosted on" +#~ " a conda channel can be installed " +#~ "using conda install. Below that there" +#~ " are two rows. the top row says" +#~ " conda channels. next to it are " +#~ "three boxes one with conda-forge, " +#~ "community maintained; bioconda and then " +#~ "default - managed by the anaconda " +#~ "team. Below that there is a row" +#~ " that says PyPI servers. PyPI - " +#~ "anyone can publish to PyPI. and " +#~ "test PyPI. a testbed server for " +#~ "you to practice." +#~ msgstr "" + +#~ msgid "" +#~ "Similarly installing packages from the " +#~ "default anaconda package mixed with the" +#~ " conda-forge channel can also lead" +#~ " to dependency conflicts." +#~ msgstr "" + +#~ msgid "Required fields for the [project] table" +#~ msgstr "" + +#~ msgid "" +#~ "As mentioned above, your pyproject.toml " +#~ "file needs to have a **name** and" +#~ " **version** field in order to " +#~ "properly build your package:" +#~ msgstr "" + +#~ msgid "Name: This is the name of your project provided as a string" +#~ msgstr "" + +#~ msgid "" +#~ "Version: This is the version of " +#~ "your project. If you are using a" +#~ " scm tool for versioning (using git" +#~ " tags to determine versions), then " +#~ "the version may be dynamic (more " +#~ "on that below)." +#~ msgstr "" + +#~ msgid "LIcense" +#~ msgstr "" + +#~ msgid "" +#~ "Here is an example of[ a package" +#~ " that has entry point " +#~ "script](https://github.com/pyOpenSci/update-web-" +#~ "metadata/blob/main/pyproject.toml#L60)s. Notice that " +#~ "there are several core scripts defined" +#~ " in that package that perform sets" +#~ " of tasks. pyOpenSci is using those" +#~ " scripts to process their metadata." +#~ msgstr "" + +#~ msgid "" +#~ "**Dynamic Fields:** if you have fields" +#~ " that are dynamically populated. One " +#~ "example of this is if you are " +#~ "using scm / version control based " +#~ "version with tools like `setuptooms_scm`, " +#~ "then you might use the dynamic " +#~ "field. such as version (using scm) " +#~ "**dynamic = [\"version\"]**" +#~ msgstr "" + +#~ msgid "" +#~ "Once you have published both package " +#~ "distributions (the source distribution and " +#~ "the wheel) to PyPI, you can then" +#~ " publish to conda-forge. conda-forge" +#~ " requires an source distribution on " +#~ "PyPI in order to build your " +#~ "package on conda-forge. You do not" +#~ " need to rebuild your package to " +#~ "publish to conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "Graphic showing the high level packaging" +#~ " workflow. On the left you see " +#~ "a graphic with code, metadata and " +#~ "tests in it. those items all go" +#~ " into your package. Documentation and " +#~ "data are below that box because " +#~ "they aren't normally published in your" +#~ " packaging wheel distribution. an arrow " +#~ "to the right takes you to a " +#~ "build distribution files box. that box" +#~ " leads you to either publishing to" +#~ " TestPyPI or the real PyPI. from " +#~ "PyPI you can then connect to " +#~ "conda-forge for an automated build " +#~ "that sends distributions from PyPI to" +#~ " conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "This screenshot shows the metadata on" +#~ " PyPI for the xclim package. on " +#~ "it you can see the name of " +#~ "the license, the author and maintainer" +#~ " names keywords associated with the " +#~ "package and the base python version " +#~ "it requires which is 3.8." +#~ msgstr "" + +#~ msgid "" +#~ "Here you see the maintinaer metadata " +#~ "as it is displayed on PyPI. for" +#~ " xclim there are three maintainers " +#~ "listed with their profile pictures and" +#~ " github user names to the right." +#~ msgstr "" + +#~ msgid "Source Distribution (sdist)" +#~ msgstr "" + +#~ msgid "Wheel (.whl files):" +#~ msgstr "" + +#~ msgid "" +#~ "There are two different layouts that " +#~ "you will commonly see within the " +#~ "Python packaging ecosystem: [src and " +#~ "flat " +#~ "layouts.](https://packaging.python.org/en/latest/discussions/src-" +#~ "layout-vs-flat-layout/) Both layouts " +#~ "have advantages for different groups of" +#~ " maintainers." +#~ msgstr "" + +#~ msgid "" +#~ "We strongly suggest, but do not " +#~ "require, that you use the **src/** " +#~ "layout (discussed below) for creating " +#~ "your Python package. This layout is " +#~ "also recommended in the [PyPA packaging" +#~ " guide](https://packaging.python.org/en/latest/tutorials" +#~ "/packaging-projects/)." +#~ msgstr "" + +#~ msgid "" +#~ "We understand that it would be " +#~ "tremendous effort for existing maintainers " +#~ "to move to a new layout." +#~ msgstr "" + +#~ msgid "An example of the **src/package** layout structure can be seen below." +#~ msgstr "" + +#~ msgid "" +#~ "**docs/:** discussed in our docs " +#~ "chapter, this directory contains your " +#~ "user-facing documentation website. In a " +#~ "**src/** layout docs/ are normally " +#~ "included at the same directory level " +#~ "of the **src/** folder." +#~ msgstr "" + +#~ msgid "" +#~ "**tests/** this directory contains the " +#~ "tests for your project code. In a" +#~ " **src/** layout tests are normally " +#~ "included at the same directory level " +#~ "of the **src/** folder." +#~ msgstr "" + +#~ msgid "" +#~ "While we recommend the **src/** layout" +#~ " we also review the **flat** layout" +#~ " here. Both are used in the " +#~ "Python ecosystem." +#~ msgstr "" + +#~ msgid "" +#~ "The benefit of using the **src/package**" +#~ " layout, particularly if you are " +#~ "creating a new package, is that it" +#~ " ensures tests are run against the" +#~ " installed version of your package " +#~ "rather than the files in your " +#~ "package working directory. If you run" +#~ " your tests on your files rather " +#~ "than the installed version, you may " +#~ "be missing issues that users encounter" +#~ " when your package is installed." +#~ msgstr "" + +#~ msgid "" +#~ "If `tests/` are outside of the " +#~ "**src/package** directory, they aren't " +#~ "included in the package wheel. This " +#~ "makes your package size slightly smaller" +#~ " which then places places a smaller" +#~ " storage burden on PyPI which has " +#~ "over 400,000 packages to support." +#~ msgstr "" + +#~ msgid "" +#~ "However, if your package lives in " +#~ "a src/ directory structure **src/package** " +#~ "then it won't be, by default, " +#~ "added to the Python path. This " +#~ "means that when you import your " +#~ "package, Python will be forced to " +#~ "search the active environment (which has" +#~ " your package installed)." +#~ msgstr "" + +#~ msgid "" +#~ "Note: Python versions 3.11 and above " +#~ "have a path setting that can be" +#~ " adjusted to ensure the priority is" +#~ " to use installed packages first " +#~ "(e.g. `PYTHONSAFEPATH`)." +#~ msgstr "" + +#~ msgid "Sometimes tests are needed in a distribution" +#~ msgstr "" + +#~ msgid "" +#~ "We do not recommend including tests " +#~ "as part of your package wheel by" +#~ " default. However, not including tests " +#~ "in your package distribution will make" +#~ " it harder for people other than " +#~ "yourself to test whether your package" +#~ " is functioning correctly on their " +#~ "system. If you have a small test" +#~ " suite (Python files + data), and " +#~ "think your users may want to run" +#~ " tests locally on their systems, you" +#~ " can include tests by moving the " +#~ "`tests/` directory into the **src/package**" +#~ " directory (see example below)." +#~ msgstr "" + +#~ msgid "" +#~ "Including the **tests/** directory in " +#~ "your **src/package** directory ensures that" +#~ " tests will be included in your " +#~ "package's wheel." +#~ msgstr "" + +#~ msgid "" +#~ "Tests, especially when accompanied by " +#~ "test data can create a few small" +#~ " challenges including:" +#~ msgstr "" + +#~ msgid "" +#~ "Take up space in your distribution " +#~ "which will build up over time as" +#~ " storage space on PyPI" +#~ msgstr "" + +#~ msgid "Large file sizes can also slow down package install." +#~ msgstr "" + +#~ msgid "" +#~ "However, in some cases, particularly in" +#~ " the scientific Python ecosystems you " +#~ "may need to include tests." +#~ msgstr "" + +#~ msgid "" +#~ "If you do include your tests in" +#~ " your package distribution, we strongly " +#~ "discourage you from including data in" +#~ " your test suite directory. Rather, " +#~ "host your test data in a " +#~ "repository such as Figshare or Zenodo." +#~ " Use a tool such as " +#~ "[Pooch](https://www.fatiando.org/pooch/latest/) to access" +#~ " the data when you (or a user)" +#~ " runs tests." +#~ msgstr "" + +#~ msgid "" +#~ "Check out the testing section of " +#~ "our guide for more information about " +#~ "tests." +#~ msgstr "" + +#~ msgid "" +#~ "If your package tests require data, " +#~ "we suggest that you do NOT include" +#~ " that data within your package " +#~ "structure. We will discuss this in " +#~ "more detail in a tutorial. Include " +#~ "data in your package structure increases" +#~ " the size of your distribution files." +#~ " This places a maintenance toll on" +#~ " repositories like PyPI and Anaconda.org" +#~ " that have to deal with thousands " +#~ "of package uploads." +#~ msgstr "" + +#~ msgid "About the flat Python package layout" +#~ msgstr "" + +#~ msgid "Currently most scientific packages use the **flat-layout** given:" +#~ msgstr "" + +#~ msgid "" +#~ "It's the most commonly found layout " +#~ "with the scientific Python ecosystem and" +#~ " people tend to look to other " +#~ "packages / maintainers that they respect" +#~ " for examples of how to build " +#~ "Python packages." +#~ msgstr "" + +#~ msgid "" +#~ "Many Python tools depend upon tools " +#~ "in other language and / or complex" +#~ " builds with compilation steps. Many " +#~ "developers thus appreciate / are used" +#~ " to features of the flat layout." +#~ msgstr "" + +#~ msgid "" +#~ "While we present this layout here " +#~ "in our guide, we suggest that " +#~ "those just getting started with python" +#~ " packaging start with the src/package " +#~ "layout discussed above. Numerous packages " +#~ "in the ecosystem [have had to move" +#~ " to a src/ layout](https://github.com/scikit-" +#~ "build/cmake-python-distributions/pull/145)" +#~ msgstr "" + +#~ msgid "" +#~ "In most cases the advantages of " +#~ "using the **src/package** layout for " +#~ "larger scientific packages that already " +#~ "use flat approach are not worth " +#~ "it. Moving from a flat layout to" +#~ " a **src/package** layout would come " +#~ "at a significant cost to maintainers." +#~ msgstr "" + +#~ msgid "" +#~ "However, the advantages of using the" +#~ " **src/package** layout for a beginner " +#~ "are significant. As such, we recommend" +#~ " that if you are getting started " +#~ "with creating a package, that you " +#~ "consider using a **src/package** layout." +#~ msgstr "" + +#~ msgid "" +#~ "It would be a significant maintenance" +#~ " cost and burden to move all of" +#~ " these packages to a different " +#~ "layout. The potential benefits of the" +#~ " source layout for these tools is " +#~ "not worth the maintenance investment." +#~ msgstr "" + +#~ msgid "" +#~ "Consistent version increases following semver" +#~ " rules mean that values of your " +#~ "package version explain the extent of" +#~ " the changes made in the code " +#~ "base from version to version. thus " +#~ "your package version numbers become " +#~ "\"expressive\" in the same way that " +#~ "naming code variables well can [make " +#~ "code expressive](https://medium.com/@daniel.oliver.king" +#~ "/writing-expressive-code-b69ef7a5a2fa)." +#~ msgstr "" + +#~ msgid "" +#~ "Generally semantic release and version " +#~ "control system tools can be setup " +#~ "to run automatically on GitHub using " +#~ "GitHub actions. This means that you " +#~ "can create a workflow where a " +#~ "GitHub release and associated new " +#~ "version tag is used to trigger an" +#~ " automated build that:" +#~ msgstr "" + +#~ msgid "" +#~ "Bumping a package version refers to " +#~ "the step of increasing the package " +#~ "version after a set number of " +#~ "changes have been made to it. For" +#~ " example, you might bump from version" +#~ " 0.8 to 0.9 of a package. or" +#~ " from 0.9 to 1.0." +#~ msgstr "" + +#~ msgid "" +#~ "When you (or your CI system) build" +#~ " your package, hatch checks the " +#~ "current tag number for your package. " +#~ "if it has increased, it will " +#~ "update the **\\_version.py** file with " +#~ "the new value." +#~ msgstr "" diff --git a/locales/ja/LC_MESSAGES/tests.po b/locales/ja/LC_MESSAGES/tests.po index a623c18da..50fba6694 100644 --- a/locales/ja/LC_MESSAGES/tests.po +++ b/locales/ja/LC_MESSAGES/tests.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,37 +18,187 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" -#: ../../tests/index.md:72 +#: ../../tests/code-cov.md:1 +#, fuzzy +msgid "Code coverage for your Python package test suite" +msgstr "Pythonパッケージのテストを書く" + +#: ../../tests/code-cov.md:3 +msgid "" +"Code coverage measures how much of your package's code runs during " +"testing. Achieving high coverage can help ensure the reliability of your " +"codebase, but it’s not a guarantee of quality. Below, we outline key " +"considerations for using code coverage effectively." +msgstr "" + +#: ../../tests/code-cov.md:8 +msgid "Why aim for high code coverage?" +msgstr "" + +#: ../../tests/code-cov.md:10 +msgid "" +"A good practice is to ensure that every line of your code runs at least " +"once during your test suite. This helps you:" +msgstr "" + +#: ../../tests/code-cov.md:13 +msgid "Identify untested parts of your codebase." +msgstr "" + +#: ../../tests/code-cov.md:14 +msgid "Catch bugs that might otherwise go unnoticed." +msgstr "" + +#: ../../tests/code-cov.md:15 +msgid "Build confidence in your software's stability." +msgstr "" + +#: ../../tests/code-cov.md:17 +msgid "Limitations of code coverage" +msgstr "" + +#: ../../tests/code-cov.md:19 +msgid "While high code coverage is valuable, it has its limits:" +msgstr "" + +#: ../../tests/code-cov.md:21 +msgid "" +"**Difficult-to-test code:** Some parts of your code might be challenging " +"to test, either due to complexity or limited resources." +msgstr "" + +#: ../../tests/code-cov.md:23 +msgid "" +"**Missed edge cases:** Running all lines of code doesn’t guarantee that " +"edge cases are handled correctly." +msgstr "" + +#: ../../tests/code-cov.md:26 +msgid "" +"Ultimately, you should focus on how your package will be used and ensure " +"your tests cover those scenarios adequately." +msgstr "" + +#: ../../tests/code-cov.md:29 +msgid "Tools for analyzing Python package code coverage" +msgstr "" + +#: ../../tests/code-cov.md:31 +msgid "" +"Some common services for analyzing code coverage are " +"[codecov.io](https://codecov.io/) and " +"[coveralls.io](https://coveralls.io/). These projects are free for open " +"source tools and will provide dashboards that tell you how much of your " +"codebase is covered during your tests. We recommend setting up an account" +" (on either CodeCov or Coveralls) and using it to keep track of your code" +" coverage." +msgstr "" + +#: ../../tests/code-cov.md:33 +#, python-format +msgid "" +"Screenshot of the code cov service - showing test coverage for the " +"stravalib package. This image shows a list of package modules and the " +"associated number of lines and % lines covered by tests. At the top of " +"the image, you can see what branch is being evaluated and the path to the" +" repository." +msgstr "" + +#: ../../tests/code-cov.md:38 +msgid "" +"The CodeCov platform is a useful tool if you wish to track code coverage " +"visually. Using it, you can not only get the same summary information " +"that you can get with the **pytest-cov** extension. You can also see what" +" lines are covered by your tests and which are not. Code coverage is " +"useful for evaluating unit tests and/or how much of your package code is " +"\"covered\". It, however, will not evaluate things like integration tests" +" and end-to-end workflows." +msgstr "" + +#: ../../tests/code-cov.md:43 +msgid "Typing & MyPy coverage" +msgstr "" + +#: ../../tests/code-cov.md:44 +msgid "You can also create and upload typing reports to CodeCov." +msgstr "" + +#: ../../tests/code-cov.md:47 +msgid "Exporting Local Coverage Reports" +msgstr "" + +#: ../../tests/code-cov.md:49 +msgid "" +"In addition to using services like CodeCov or Coveralls, you can generate" +" local coverage reports directly using the **coverage.py** tool. This can" +" be especially useful if you want to create reports in Markdown or HTML " +"format for offline use or documentation." +msgstr "" + +#: ../../tests/code-cov.md:51 +msgid "To generate a coverage report in **Markdown** format, run:" +msgstr "" + +#: ../../tests/code-cov.md:56 +msgid "" +"This command will produce a Markdown-formatted coverage summary that you " +"can easily include in project documentation or share with your team." +msgstr "" + +#: ../../tests/code-cov.md:58 +msgid "" +"To generate an HTML report that provides a detailed, interactive view of " +"which lines are covered, use:" +msgstr "" + +#: ../../tests/code-cov.md:64 +msgid "" +"The generated HTML report will be saved in a directory named htmlcov by " +"default. Open the index.html file in your browser to explore your " +"coverage results." +msgstr "" + +#: ../../tests/code-cov.md:66 +msgid "" +"These local reports are an excellent way to quickly review coverage " +"without setting up an external service." +msgstr "" + +#: ../../tests/index.md:73 msgid "Intro" msgstr "イントロ" -#: ../../tests/index.md:72 +#: ../../tests/index.md:73 msgid "Write tests" msgstr "テストを書く" -#: ../../tests/index.md:72 +#: ../../tests/index.md:73 msgid "Test types" msgstr "テストの種類" -#: ../../tests/index.md:72 +#: ../../tests/index.md:73 msgid "Run tests locally" msgstr "ローカルでテストを実行する" -#: ../../tests/index.md:72 +#: ../../tests/index.md:73 msgid "Run tests online (using CI)" msgstr "オンラインでテストを実行する(CIを使用する)" -#: ../../tests/index.md:72 +#: ../../tests/index.md:73 +msgid "Code coverage" +msgstr "" + +#: ../../tests/index.md:73 msgid "Create & Run Tests" msgstr "テストの作成と実行" -#: ../../tests/index.md:1 +#: ../../tests/index.md:2 msgid "Tests and data for your Python package" msgstr "Pythonパッケージのテストとデータ" -#: ../../tests/index.md:3 +#: ../../tests/index.md:4 msgid "" "Tests are an important part of your Python package because they provide a" " set of checks that ensure that your package is functioning how you " @@ -57,20 +207,21 @@ msgstr "" "テストは Python " "パッケージの重要な一部です。なぜなら、テストはパッケージが期待通りに動作しているかどうかを確認するための一連のチェック機能を提供するからです。" -#: ../../tests/index.md:7 +#: ../../tests/index.md:8 +#, fuzzy msgid "" -"In this section you will learn more about the importance of writing tests" -" for your Python package and how you can setup infrastructure to run your" -" tests both locally and on GitHub." +"In this section, you will learn more about the importance of writing " +"tests for your Python package and how you can set up infrastructure to " +"run your tests both locally and on GitHub." msgstr "" "このセクションでは、Python パッケージのテストを書くことの重要性と、ローカルと GitHub " "の両方でテストを実行するためのインフラストラクチャの設定方法について学びます。" -#: ../../tests/index.md:19 +#: ../../tests/index.md:20 msgid "✨ Why write tests ✨" msgstr "✨テストを書く理由✨" -#: ../../tests/index.md:24 +#: ../../tests/index.md:25 msgid "" "Learn more about the art of writing tests for your Python package. Learn " "about why you should write tests and how they can help you and potential " @@ -79,11 +230,11 @@ msgstr "" "Python パッケージのテストを書く技術についてもっと学びましょう。 " "なぜテストを書く必要があるのか、そしてテストがどのようにあなたやあなたのプロジェクトへの将来の貢献者の助けになるのかを学びましょう。" -#: ../../tests/index.md:31 +#: ../../tests/index.md:32 msgid "✨ Types of tests ✨" msgstr "✨テストの種類✨" -#: ../../tests/index.md:36 +#: ../../tests/index.md:37 msgid "" "There are three general types of tests that you can write for your Python" " package: unit tests, integration tests and end-to-end (or functional) " @@ -92,11 +243,11 @@ msgstr "" "Python パッケージで書くことのできるテストには、ユニットテスト、統合テスト、エンドツーエンドテスト (あるいは機能テスト) の 3 " "種類があります。 この 3 つについて学びましょう。" -#: ../../tests/index.md:42 +#: ../../tests/index.md:43 msgid "✨ Run tests locally ✨" msgstr "✨ローカルでテストを実行する✨" -#: ../../tests/index.md:47 +#: ../../tests/index.md:48 msgid "" "If you expect your users to use your package across different versions of" " Python, then using an automation tool such as nox to run your tests is " @@ -107,13 +258,14 @@ msgstr "" "のような自動化ツールを使うと便利です。 Python " "のバージョンにまたがってテストを実行するために使える様々なツールについては、こちらを参照してください。" -#: ../../tests/index.md:53 +#: ../../tests/index.md:54 msgid "✨ Run tests online (using CI) ✨" msgstr "✨オンラインでテストを実行する(CIを使用する)✨" -#: ../../tests/index.md:58 +#: ../../tests/index.md:59 +#, fuzzy msgid "" -"Continuous integration platforms such as GitHub actions can be useful for" +"Continuous integration platforms such as GitHub Actions can be useful for" " running your tests across both different Python versions and different " "operating systems. Learn about setting up tests to run in Continuous " "Integration here." @@ -122,7 +274,7 @@ msgstr "" "のバージョンやオペレーティングシステムの違いを問わずテストを実行するのに便利です。 " "継続的インテグレーションで実行するテストの設定については、こちらを参照してください。" -#: ../../tests/index.md:69 +#: ../../tests/index.md:70 msgid "Graphic showing the elements of the packaging process." msgstr "パッケージング工程の要素を示すグラフィック。" @@ -161,14 +313,14 @@ msgstr "" "隔離された環境でテストを実行することで、テストとその再現性に自信を持つことができます。 " "これにより、あなたのコンピュータの設定によってテストがランダムにパスすることがなくなります。 " "たとえば、あなたのパッケージの依存関係リストで宣言されていない依存関係を、予期せずローカルシステムにインストールしてしまったかもしれません。 " -"このような見落としは、他の人があなたのパッケージを自分のコン ピュータにインストールしたり実行しようとしたときに、問題につながる可能性 があります。" +"このような見落としは、他の人があなたのパッケージを自分のコン ピュータにインストールしたり実行しようとしたときに、問題につながる可能性 " +"があります。" #: ../../tests/run-tests.md:14 msgid "" "On this page, you will learn about the tools that you can use to both run" " tests in isolated environments and across Python versions." -msgstr "" -"このページでは、隔離された環境でテストを実行したり、Python のバージョンを越えてテストを実行したりするために使えるツールについて学びます。" +msgstr "このページでは、隔離された環境でテストを実行したり、Python のバージョンを越えてテストを実行したりするために使えるツールについて学びます。" #: ../../tests/run-tests.md:19 msgid "Tools to run your tests" @@ -215,7 +367,8 @@ msgstr "" "[**nox**](https://nox.thea.codes/en/stable/index.html) や " "[**tox**](https://tox.wiki/en/latest/index.html) " "のようなツールも、Pythonのバージョンをまたいでテストを実行できます。 " -"しかし、noxとtoxだけを使って異なるオペレーティングシステムでビルドをテストするのは難しいでしょう - ここで継続的インテグレーション(CI)の出番です。" +"しかし、noxとtoxだけを使って異なるオペレーティングシステムでビルドをテストするのは難しいでしょう - " +"ここで継続的インテグレーション(CI)の出番です。" #: ../../tests/run-tests.md:26 msgid "" @@ -363,7 +516,8 @@ msgid "" "Or if you want to run a specific test file - let's call this file " "\"`test_module.py`\" - you can run:" msgstr "" -"また、特定のテストファイル - このファイルを \"`test_module.py`\" と呼ぶことにします - を実行したい場合は、次のようにします:" +"また、特定のテストファイル - このファイルを \"`test_module.py`\" と呼ぶことにします - " +"を実行したい場合は、次のようにします:" #: ../../tests/run-tests.md:99 msgid "`pytest test_module.py`" @@ -374,8 +528,8 @@ msgid "" "Learn more from the [get started docs](https://docs.pytest.org/en/7.1.x" "/getting-started.html)." msgstr "" -"詳しくは [ドキュメントスタートガイド](https://docs.pytest.org/en/7.1.x/getting-started.html) " -"をご覧ください。" +"詳しくは [ドキュメントスタートガイド](https://docs.pytest.org/en/7.1.x/getting-" +"started.html) をご覧ください。" #: ../../tests/run-tests.md:103 msgid "" @@ -418,8 +572,8 @@ msgid "" "environments and across Python versions." msgstr "" "一つのコマンドで様々な Python のバージョンや特定の環境でテストを実行するには、 `nox` や `tox` " -"のような自動化ツールを使うことができます。 `nox` も `tox` も、隔離された仮想環境を作成することができます。 これにより、複数の環境や " -"Python のバージョンをまたいだテストを簡単に実行することができます。" +"のような自動化ツールを使うことができます。 `nox` も `tox` も、隔離された仮想環境を作成することができます。 これにより、複数の環境や" +" Python のバージョンをまたいだテストを簡単に実行することができます。" #: ../../tests/run-tests.md:120 msgid "" @@ -439,18 +593,16 @@ msgid "Other automation tools you'll see in the wild" msgstr "その他の自動化ツール" #: ../../tests/run-tests.md:125 +#, fuzzy msgid "" "**[Tox](https://tox.wiki/en/latest/index.html#useful-links)** is an " "automation tool that supports common steps such as building " "documentation, running tests across various versions of Python, and more." -" You can find [a nice overview of tox in the plasmaPy " -"documentation](https://docs.plasmapy.org/en/stable/contributing/testing_guide.html" -"#using-tox)." msgstr "" "**[Tox](https://tox.wiki/en/latest/index.html#useful-links)** " "は自動化ツールで、ドキュメントのビルドや、Pythonの様々なバージョン間でのテストの実行など、一般的なステップをサポートしています。 " -"[plasmaPyのドキュメントによいtoxの概要があります](https://docs.plasmapy.org/en/stable/contributing/testing_guide.html#using-" -"tox) 。" +"[plasmaPyのドキュメントによいtoxの概要があります](https://docs.plasmapy.org/en/stable/contributing/testing_guide.html" +"#using-tox) 。" #: ../../tests/run-tests.md:127 msgid "" @@ -462,8 +614,8 @@ msgid "" "capabilities rather than using `nox`." msgstr "" "**[Hatch](https://github.com/ofek/hatch)** " -"は、hatchlingと呼ばれる人気のあるビルドバックエンドで動作する最新のエンドツーエンドパッケージングツールです。 `hatch` は `tox`" -" のようなセットアップを提供し、異なる Python バージョンを使ってローカルでテストを実行することができます。 " +"は、hatchlingと呼ばれる人気のあるビルドバックエンドで動作する最新のエンドツーエンドパッケージングツールです。 `hatch` は " +"`tox` のようなセットアップを提供し、異なる Python バージョンを使ってローカルでテストを実行することができます。 " "パッケージングのワークフローをサポートするために `hatch` を使っているのであれば、 `nox` を使うよりも `hatch` " "のテスト機能を使った方が良いかもしれない。" @@ -517,8 +669,8 @@ msgid "" "versions, nox will create and manage individual `venv` environments for " "each Python version that you specify in the nox function." msgstr "" -"異なる Python バージョン間でテストを実行するために nox をインストールして使用する場合、nox は nox 関数で指定した Python " -"バージョンごとに個別の `venv` 環境を作成して管理します。" +"異なる Python バージョン間でテストを実行するために nox をインストールして使用する場合、nox は nox 関数で指定した " +"Python バージョンごとに個別の `venv` 環境を作成して管理します。" #: ../../tests/run-tests.md:152 msgid "Nox will manage each environment on its own." @@ -556,8 +708,8 @@ msgid "" " not interfere with each other, promoting a clean and organized " "development environment." msgstr "" -"デフォルトでは、 `nox` は Python 組み込みの `venv` 環境マネージャを使用します。 仮想環境 (`venv`) は自己完結型の " -"Python 環境で、異なる Python プロジェクトの依存関係を分離して管理することができます。 " +"デフォルトでは、 `nox` は Python 組み込みの `venv` 環境マネージャを使用します。 仮想環境 (`venv`) は自己完結型の" +" Python 環境で、異なる Python プロジェクトの依存関係を分離して管理することができます。 " "プロジェクト固有のライブラリやパッケージが互いに干渉しないようにし、クリーンで整理された開発環境を促進します。" #: ../../tests/run-tests.md:166 @@ -588,8 +740,7 @@ msgstr "TODO: 上記のテストをいくつか追加し、以下の例で出力 msgid "" "Below is an example of setting up nox to run tests using `venv` which is " "the built in environment manager that comes with base Python." -msgstr "" -"以下は、Pythonに組み込まれている環境マネージャーである `venv` を使ってテストを実行するようにnoxをセットアップする例です。" +msgstr "以下は、Pythonに組み込まれている環境マネージャーである `venv` を使ってテストを実行するようにnoxをセットアップする例です。" #: ../../tests/run-tests.md:180 msgid "" @@ -598,9 +749,9 @@ msgid "" "understand](../package-structure-code/declare-dependencies.md). An " "example of that setup is below." msgstr "" -"以下の例では、 [pipが理解できる方法でテストの依存関係を宣言するように`pyproject.toml`をセットアップする](../package-" -"structure-code/declare-dependencies.md) ことを前提としていることに注意してください。 " -"そのセットアップの例を以下に示します。" +"以下の例では、 [pipが理解できる方法でテストの依存関係を宣言するように`pyproject.toml`をセットアップする" +"](../package-structure-code/declare-dependencies.md) " +"ことを前提としていることに注意してください。 そのセットアップの例を以下に示します。" #: ../../tests/run-tests.md:201 msgid "" @@ -609,8 +760,8 @@ msgid "" " that below one single nox session allows you to run your tests on 4 " "different Python environments (Python 3.9, 3.10, 3.11, and 3.12)." msgstr "" -"上記の設定ができていれば、 `session.install(\".[tests]\")` を使ってテストの依存関係をインストールすることができます。 " -"以下のように、1つのnoxセッションで4つの異なるPython環境（Python " +"上記の設定ができていれば、 `session.install(\".[tests]\")` " +"を使ってテストの依存関係をインストールすることができます。 以下のように、1つのnoxセッションで4つの異なるPython環境（Python " "3.9、3.10、3.11、3.12）でテストを実行できることに注意してください。" #: ../../tests/run-tests.md:222 @@ -638,9 +789,10 @@ msgstr "conda / mamba による nox" #: ../../tests/run-tests.md:236 msgid "" "Below is an example for setting up nox to use mamba (or conda) for your " -"environment manager. Note that unlike venv, conda can automatically install " -"the various versions of Python that you need. You won't need to install all " -"four Python versions if you use conda/mamba, like you do with `venv`." +"environment manager. Note that unlike venv, conda can automatically " +"install the various versions of Python that you need. You won't need to " +"install all four Python versions if you use conda/mamba, like you do with" +" `venv`." msgstr "" "以下は、noxが環境マネージャーにmamba（またはconda）を使うように設定する例です。venvと違って、condaは必要なPythonの様々なバージョンを自動的にインストールできることに注意してください。conda/mambaを使う場合は、" " `venv` のように4つのPythonバージョンをインストールする必要はありません。" @@ -707,8 +859,7 @@ msgid "" "isolation to ensure that they work correctly. The goal of unit testing is" " to verify that each part of the software, typically at the function or " "method level, performs its intended task correctly." -msgstr "" -"単体テストは、個々のコンポーネントやコードの単位を分離してテストし、それらが正しく動作することを確認するものです。単体テストの目的は、ソフトウェアの各部分、通常は関数やメソッドのレベルが、意図したタスクを正しく実行することを検証することです。" +msgstr "単体テストは、個々のコンポーネントやコードの単位を分離してテストし、それらが正しく動作することを確認するものです。単体テストの目的は、ソフトウェアの各部分、通常は関数やメソッドのレベルが、意図したタスクを正しく実行することを検証することです。" #: ../../tests/test-types.md:24 msgid "" @@ -717,8 +868,7 @@ msgid "" "don’t fit together, you will never complete it. Similarly, when working " "with code, tests ensure that each function, attribute, class, method " "works properly when isolated." -msgstr "" -"単体テストは、パズルの各パーツが壊れていないかどうかを調べることに例えることができます。パズルのピースがすべて合わなければ、完成することはありません。同様に、コードを扱う場合、テストは各関数、プロパティ、クラス、メソッドが分離されたときに正しく機能することを保証します。" +msgstr "単体テストは、パズルの各パーツが壊れていないかどうかを調べることに例えることができます。パズルのピースがすべて合わなければ、完成することはありません。同様に、コードを扱う場合、テストは各関数、プロパティ、クラス、メソッドが分離されたときに正しく機能することを保証します。" #: ../../tests/test-types.md:26 msgid "" @@ -759,8 +909,7 @@ msgid "" " or integrate. Integration tests can be compared to connecting a bunch of" " puzzle pieces together to form a whole picture. Integration tests focus " "on how different pieces of your code fit and work together." -msgstr "" -"統合テストでは、パッケージの各パーツがどのように連動するか、あるいは統合されるかをテストします。統合テストは、パズルのピースをつなげて全体像を作るようなものです。統合テストは、コードのさまざまな部分がどのように適合し、連携して動作するかに焦点を当てます。" +msgstr "統合テストでは、パッケージの各パーツがどのように連動するか、あるいは統合されるかをテストします。統合テストは、パズルのピースをつなげて全体像を作るようなものです。統合テストは、コードのさまざまな部分がどのように適合し、連携して動作するかに焦点を当てます。" #: ../../tests/test-types.md:76 msgid "" @@ -769,8 +918,7 @@ msgid "" "then provided an average temperature for a particular time period. An " "integration test would ensure that all parts of that workflow behaved as " "expected." -msgstr "" -"例えば、スプレッドシートに温度データを収集し、摂氏から華氏に変換し、特定の期間の平均温度を提供する一連のステップがあったとします。統合テストは、そのワークフローのすべての部分が期待通りに動作することを保証します。" +msgstr "例えば、スプレッドシートに温度データを収集し、摂氏から華氏に変換し、特定の期間の平均温度を提供する一連のステップがあったとします。統合テストは、そのワークフローのすべての部分が期待通りに動作することを保証します。" #: ../../tests/test-types.md:107 msgid "" @@ -785,8 +933,7 @@ msgid "" "elements in the puzzle. The same is true with individual functions, " "methods and classes in your software. The code needs to work both " "individually and together to perform certain sets of tasks." -msgstr "" -"パズルのピースの両端が欠けていると、パズルの他の要素と連動することができません。ソフトウェアの個々の関数、メソッド、クラスについても同様です。コードは、ある一連のタスクを実行するために、個々に、そして一緒に働く必要があります。" +msgstr "パズルのピースの両端が欠けていると、パズルの他の要素と連動することができません。ソフトウェアの個々の関数、メソッド、クラスについても同様です。コードは、ある一連のタスクを実行するために、個々に、そして一緒に働く必要があります。" #: ../../tests/test-types.md:120 msgid "" @@ -827,16 +974,14 @@ msgid "" "End-to-end test also test how a program runs from start to finish. A " "tutorial that you add to your documentation that runs in CI in an " "isolated environment is another example of an end-to-end test." -msgstr "" -"エンドツーエンドのテストも、プログラムが最初から最後までどのように実行されるかをテストします。ドキュメントに追加するチュートリアルは、分離された環境のCIで実行され、エンドツーエンドのテストのもう一つの例です。" +msgstr "エンドツーエンドのテストも、プログラムが最初から最後までどのように実行されるかをテストします。ドキュメントに追加するチュートリアルは、分離された環境のCIで実行され、エンドツーエンドのテストのもう一つの例です。" #: ../../tests/test-types.md:140 msgid "" "For scientific packages, creating short tutorials that highlight core " "workflows that your package supports, that are run when your " "documentation is built could also serve as end-to-end tests." -msgstr "" -"科学的なパッケージの場合、パッケージがサポートする中核的なワークフローを強調する短いチュートリアルを作成し、ドキュメントのビルド時に実行することで、エンドツーエンドのテストを兼ねることができます。" +msgstr "科学的なパッケージの場合、パッケージがサポートする中核的なワークフローを強調する短いチュートリアルを作成し、ドキュメントのビルド時に実行することで、エンドツーエンドのテストを兼ねることができます。" #: ../../tests/test-types.md:143 msgid "Comparing unit, integration and end-to-end tests" @@ -863,8 +1008,7 @@ msgid "" "didn't introduce new behavior to your existing code, then you can rely on" " your unit tests to continue to pass, testing the original functionality " "of your code." -msgstr "" -"統合テストとエンドツーエンドテストは、プログラムのさまざまな部分が連携して動作することを検証しますが、どこでエラーが発生しているかを切り分けるにはあまり適していません。例えば、コードをリファクタリングすると、エンドツーエンドのテストが壊れる可能性があります。しかし、リファクタリングによって既存のコードに新しい動作が導入されなかったのであれば、コードの元の機能をテストするユニットテストがパスし続けることに頼ることができます。" +msgstr "統合テストとエンドツーエンドテストは、プログラムのさまざまな部分が連携して動作することを検証しますが、どこでエラーが発生しているかを切り分けるにはあまり適していません。例えば、コードをリファクタリングすると、エンドツーエンドのテストが壊れる可能性があります。しかし、リファクタリングによって既存のコードに新しい動作が導入されなかったのであれば、コードの元の機能をテストするユニットテストがパスし続けることに頼ることができます。" #: ../../tests/test-types.md:152 msgid "" @@ -875,8 +1019,7 @@ msgid "" "different types of tests can provides a framework to help you think about" " writing tests and how different types of tests can complement each " "other." -msgstr "" -"重要なのは、さまざまな種類のテストにまつわる詳細について心配することにエネルギーを費やす必要はないということです。テストスイートの作成に取りかかるときには、パッケージが何をするのか、そしてパッケージの一部をどのようにテストする必要があるのかを考えてください。さまざまな種類のテストに慣れ親しむことは、テストの書き方や、さまざまな種類のテストが互いにどのように補完し合えるかを考える際のフレームワークとなります。" +msgstr "重要なのは、さまざまな種類のテストにまつわる詳細について心配することにエネルギーを費やす必要はないということです。テストスイートの作成に取りかかるときには、パッケージが何をするのか、そしてパッケージの一部をどのようにテストする必要があるのかを考えてください。さまざまな種類のテストに慣れ親しむことは、テストの書き方や、さまざまな種類のテストが互いにどのように補完し合えるかを考える際のフレームワークとなります。" #: ../../tests/tests-ci.md:1 msgid "Run tests with Continuous Integration" @@ -932,12 +1075,14 @@ msgstr "" "開発環境の構築、テストの実行、ドキュメントのビルドをローカルで行うことなく、コードやドキュメントの修正などに貢献することができます。" #: ../../tests/tests-ci.md:22 -msgid "Example GitHub action that runs tests" +#, fuzzy +msgid "Example GitHub Actions that runs tests" msgstr "テストを実行する GitHub Actionsの例" #: ../../tests/tests-ci.md:24 +#, fuzzy msgid "" -"Below is an example GitHub action that runs tests using nox across both " +"Below is an example GitHub Actions that runs tests using nox across both " "Windows, Mac and Linux and on Python versions 3.9-3.11." msgstr "" "以下は、Windows、Mac、Linuxの両方で、Pythonのバージョン3.9-3.11でnoxを使ってテストを実行するGitHub " @@ -1041,16 +1186,17 @@ msgstr "" "パッケージが進化するにつれて、テストは、時間の経過とともに変更を加えても、コードが期待通りに動作し続けることを保証します。こうして、テストを書くときに将来の自分を助けることになります。" #: ../../tests/write-tests.md:21 +#, fuzzy msgid "" "**Easier pull request reviews:** By running your tests in a CI framework " -"such as GitHub actions, each time you or a contributor makes a change to " +"such as GitHub Actions, each time you or a contributor makes a change to " "your code-base, you can catch issues and things that may have changed in " "your code base. This ensures that your software behaves the way you " "expect it to." msgstr "" "**より簡単なプルリクエストのレビュー:** GitHub actions のような CI " -"フレームワークでテストを実行することで、あなたや貢献者がコードベースに変更を加えるたびに、コードベースの問題や変更点をキャッチすることができます。 " -"これにより、あなたのソフトウェアが期待通りに動作することが保証されます。" +"フレームワークでテストを実行することで、あなたや貢献者がコードベースに変更を加えるたびに、コードベースの問題や変更点をキャッチすることができます。" +" これにより、あなたのソフトウェアが期待通りに動作することが保証されます。" #: ../../tests/write-tests.md:23 msgid "Tests for user edge cases" @@ -1076,9 +1222,8 @@ msgid "" "lesson](https://swcarpentry.github.io/python-novice-" "inflammation/10-defensive.html)" msgstr "" -"テストの入門書としては、 [このSoftware " -"Carpentryのレッスン](https://swcarpentry.github.io/python-novice-" -"inflammation/10-defensive.html) を参照してください。" +"テストの入門書としては、 [このSoftware Carpentryのレッスン](https://swcarpentry.github.io" +"/python-novice-inflammation/10-defensive.html) を参照してください。" #: ../../tests/write-tests.md:41 msgid "" @@ -1157,8 +1302,8 @@ msgid "" "still works with both the values 1 and less than one and 1.001 as well " "(something close to the constraint value).." msgstr "" -"**予想される境界線とその付近でテストする:** 関数が1以上の値を必要とする場合、この関数が、1と1未満と1.001の両方の値 (制約値に近い値) " -"でも動作することを確認してください。" +"**予想される境界線とその付近でテストする:** 関数が1以上の値を必要とする場合、この関数が、1と1未満と1.001の両方の値 " +"(制約値に近い値) でも動作することを確認してください。" #: ../../tests/write-tests.md:88 msgid "" diff --git a/locales/ja/LC_MESSAGES/tutorials.po b/locales/ja/LC_MESSAGES/tutorials.po index 7eb0df48d..8e8d114d1 100644 --- a/locales/ja/LC_MESSAGES/tutorials.po +++ b/locales/ja/LC_MESSAGES/tutorials.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: pyOpenSci Python Package Guide \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-08-02 18:04+0900\n" +"POT-Creation-Date: 2025-02-17 22:50+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language: ja\n" @@ -18,7 +18,7 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.15.0\n" +"Generated-By: Babel 2.17.0\n" #: ../../tutorials/add-license-coc.md:1 msgid "Add a `LICENSE` & `CODE_OF_CONDUCT` to your Python package" @@ -79,12 +79,12 @@ msgstr "" #: ../../tutorials/add-license-coc.md:23 msgid "" -"create a `LICENSE` file in your project directory that specifies the " -"license that you choose for your package and" +"Create a `LICENSE` file in your project directory that specifies the " +"license that you choose for your package." msgstr "" #: ../../tutorials/add-license-coc.md:24 -msgid "reference that file in your `pyproject.toml` data where metadata are set." +msgid "Reference that file in your `pyproject.toml` data where metadata are set." msgstr "" #: ../../tutorials/add-license-coc.md:26 @@ -913,6 +913,50 @@ msgstr "" msgid "Discourages misuse of your package and associated code" msgstr "" +#: ../../tutorials/command-line-reference.md:1 ../../tutorials/intro.md:54 +msgid "Command Line Reference Guide" +msgstr "" + +#: ../../tutorials/command-line-reference.md:4 +msgid "" +"**What these tables are:** These tables summarize the command line inputs" +" (e.g., `pipx install hatch`, `hatch build`) necessary to complete all " +"steps in the package creation process, from installing Hatch to " +"publishing the package on PyPI and conda-forge." +msgstr "" + +#: ../../tutorials/command-line-reference.md:6 +msgid "" +"**What these tables are not:** These tables do not cover the manual/non-" +"automated steps (e.g., create PyPI account, create PyPI API token) you " +"have to complete throughout the package creation process." +msgstr "" + +#: ../../tutorials/command-line-reference.md:8 +msgid "" +"**Operating system note:** The current iteration of this guide has been " +"tested on the Windows OS only. Many commands are Windows-specific. OS-" +"specific commands are indicated with parentheses after the description of" +" the command, e.g., [COMMAND_DESCRIPTION] (Windows). Corresponding " +"commands for macOS and Linux will be added in the future." +msgstr "" + +#: ../../tutorials/command-line-reference.md:11 +msgid "Environment Setup" +msgstr "" + +#: ../../tutorials/command-line-reference.md:33 +msgid "Package Development" +msgstr "" + +#: ../../tutorials/command-line-reference.md:52 +msgid "Package Publishing" +msgstr "" + +#: ../../tutorials/command-line-reference.md:71 +msgid "Versions and Environments" +msgstr "" + #: ../../tutorials/get-to-know-hatch.md:1 msgid "Get to Know Hatch" msgstr "" @@ -1165,7 +1209,7 @@ msgstr "" #: ../../tutorials/get-to-know-hatch.md:192 #: ../../tutorials/installable-code.md:22 #: ../../tutorials/installable-code.md:411 -#: ../../tutorials/installable-code.md:502 ../../tutorials/intro.md:226 +#: ../../tutorials/installable-code.md:502 ../../tutorials/intro.md:235 #: ../../tutorials/publish-pypi.md:3 ../../tutorials/publish-pypi.md:178 #: ../../tutorials/publish-pypi.md:350 ../../tutorials/pyproject-toml.md:718 msgid "Todo" @@ -1194,7 +1238,7 @@ msgstr "" #: ../../tutorials/get-to-know-hatch.md:202 msgid "" "`hatch config show` will print out the contents of your `config.toml` " -"file in your shell. look at the values and ensure that your name, email " +"file in your shell. Look at the values and ensure that your name, email " "is set. Also make sure that `tests=false`." msgstr "" @@ -1229,7 +1273,7 @@ msgstr "" #: ../../tutorials/get-to-know-hatch.md:220 msgid "" -"it will convert metadata stored in a `setup.py` or `setup.cfg` file to a " +"It will convert metadata stored in a `setup.py` or `setup.cfg` file to a " "pyproject.toml file for you (see [Migrating setup.py to pyproject.toml " "using Hatch](setup-py-to-pyproject-toml.md ))" msgstr "" @@ -1298,7 +1342,7 @@ msgstr "" msgid "" "ADD: note about what makes something \"package worthy\", with a common " "misconception being that a package should be production-ready code that's" -" valuable to a broad audience. this may not be a pervasive misconception " +" valuable to a broad audience. This may not be a pervasive misconception " "in Python, but a quick break-out with an explanation of what a package " "can consist of would be helpful." msgstr "" @@ -1435,7 +1479,7 @@ msgid "An `__init__.py` file in your code directory." msgstr "" #: ../../tutorials/installable-code.md:83 -msgid "The directory structure you’ll create in this lesson will look like this:" +msgid "The directory structure you'll create in this lesson will look like this:" msgstr "" #: ../../tutorials/installable-code.md:95 @@ -1509,7 +1553,7 @@ msgstr "" #: ../../tutorials/installable-code.md:121 msgid "" -"Where you define your project’s metadata (including its name, authors, " +"Where you define your project's metadata (including its name, authors, " "license, etc)" msgstr "" @@ -1734,7 +1778,7 @@ msgstr "" #: ../../tutorials/installable-code.md:282 msgid "" -"If you aren’t familiar with docstrings or typing yet, that is ok. You can" +"If you aren't familiar with docstrings or typing yet, that is ok. You can" " review [this page in the pyOpenSci packaging " "guide](https://www.pyopensci.org/python-package-guide/documentation" "/write-user-documentation/document-your-code-api-docstrings.html) for an " @@ -1901,7 +1945,7 @@ msgstr "" #: ../../tutorials/installable-code.md:482 msgid "" "Once you have your project metadata in the pyproject.toml file, you will " -"rarely update it. In the next lesson you’ll add more metadata and " +"rarely update it. In the next lesson you'll add more metadata and " "structure to this file." msgstr "" @@ -2153,74 +2197,78 @@ msgstr "" msgid "[epydoc](https://epydoc.sourceforge.net/epytext.html)" msgstr "" -#: ../../tutorials/intro.md:27 ../../tutorials/setup-py-to-pyproject-toml.md:24 +#: ../../tutorials/intro.md:28 ../../tutorials/setup-py-to-pyproject-toml.md:24 msgid "Get to know Hatch" msgstr "" -#: ../../tutorials/intro.md:27 +#: ../../tutorials/intro.md:28 msgid "Python Packaging Tutorial Setup" msgstr "" -#: ../../tutorials/intro.md:34 ../../tutorials/intro.md:71 +#: ../../tutorials/intro.md:35 ../../tutorials/intro.md:80 msgid "What is a Python package?" msgstr "" -#: ../../tutorials/intro.md:34 +#: ../../tutorials/intro.md:35 msgid "Make your code installable" msgstr "" -#: ../../tutorials/intro.md:34 +#: ../../tutorials/intro.md:35 msgid "Publish to PyPI" msgstr "" -#: ../../tutorials/intro.md:34 +#: ../../tutorials/intro.md:35 msgid "Publish to conda-forge" msgstr "" -#: ../../tutorials/intro.md:34 +#: ../../tutorials/intro.md:35 msgid "Create and publish a Python Package" msgstr "" -#: ../../tutorials/intro.md:44 +#: ../../tutorials/intro.md:45 msgid "Add README file" msgstr "" -#: ../../tutorials/intro.md:44 +#: ../../tutorials/intro.md:45 msgid "Add a license & code of conduct" msgstr "" -#: ../../tutorials/intro.md:44 +#: ../../tutorials/intro.md:45 msgid "Update metadata in pyproject.toml" msgstr "" -#: ../../tutorials/intro.md:44 +#: ../../tutorials/intro.md:45 msgid "Project information files & metadata" msgstr "" -#: ../../tutorials/intro.md:53 +#: ../../tutorials/intro.md:54 +msgid "Reference Guides" +msgstr "" + +#: ../../tutorials/intro.md:61 msgid "Migrate setup.py to a pyproject.toml using Hatch" msgstr "" -#: ../../tutorials/intro.md:53 +#: ../../tutorials/intro.md:61 msgid "Hatch for Existing Packages" msgstr "" -#: ../../tutorials/intro.md:1 +#: ../../tutorials/intro.md:2 msgid "Python packaging 101" msgstr "" -#: ../../tutorials/intro.md:3 +#: ../../tutorials/intro.md:4 msgid "_A start to finish beginner-friendly tutorial_" msgstr "" -#: ../../tutorials/intro.md:5 +#: ../../tutorials/intro.md:6 msgid "" "Welcome to the pyOpenSci Python packaging tutorial series. The lessons on" " the upcoming pages walk you through the core steps needed to create a " "Python package." msgstr "" -#: ../../tutorials/intro.md:11 +#: ../../tutorials/intro.md:12 msgid "" "Diagram showing the lessons in our packaging tutorial. There are 6 total " "- what is a Python package, make code pip installable, publish your " @@ -2228,17 +2276,17 @@ msgid "" " finally publish to conda forge." msgstr "" -#: ../../tutorials/intro.md:13 +#: ../../tutorials/intro.md:14 msgid "" "This lesson is the first in a series of lessons to help you get started " "with Python packaging." msgstr "" -#: ../../tutorials/intro.md:16 +#: ../../tutorials/intro.md:17 msgid "Who are these tutorials for?" msgstr "" -#: ../../tutorials/intro.md:18 +#: ../../tutorials/intro.md:19 msgid "" "The content in this tutorial series is beginner friendly and assumes that" " you have not created a Python package before. However, the content will " @@ -2246,52 +2294,52 @@ msgid "" " involved in creating a Python package." msgstr "" -#: ../../tutorials/intro.md:23 +#: ../../tutorials/intro.md:24 msgid "" "In this series you will learn about the core elements that you need to " "publish your package to the [Python Package Index " "(PyPI)](https://pypi.org/)." msgstr "" -#: ../../tutorials/intro.md:25 +#: ../../tutorials/intro.md:26 msgid "" "In the second series, you will learn about infrastructure and " "documentation needed to support package maintenance." msgstr "" -#: ../../tutorials/intro.md:60 ../../tutorials/publish-conda-forge.md:15 +#: ../../tutorials/intro.md:68 ../../tutorials/publish-conda-forge.md:15 #: ../../tutorials/publish-pypi.md:13 ../../tutorials/pyproject-toml.md:19 #: ../../tutorials/setup-py-to-pyproject-toml.md:12 msgid "Learning Objectives" msgstr "" -#: ../../tutorials/intro.md:62 +#: ../../tutorials/intro.md:70 msgid "" "This lesson introduces you to the basic components of a Python package. " "After reading this lesson you will:" msgstr "" -#: ../../tutorials/intro.md:65 +#: ../../tutorials/intro.md:73 msgid "Understand what a Python package is" msgstr "" -#: ../../tutorials/intro.md:66 +#: ../../tutorials/intro.md:74 msgid "Be able to list the 5 core components of a Python package" msgstr "" -#: ../../tutorials/intro.md:67 +#: ../../tutorials/intro.md:75 msgid "" "Be able to explain the difference between generalizable code and code " "that supports a specific scientific application" msgstr "" -#: ../../tutorials/intro.md:73 +#: ../../tutorials/intro.md:82 msgid "" "At a high level, you can think about a Python package as a toolbox that " "you can use to perform various tasks." msgstr "" -#: ../../tutorials/intro.md:76 +#: ../../tutorials/intro.md:85 msgid "" "A Python package is basically a directory with a specific file structure." " Within the package directory structure, there are modules which are " @@ -2301,23 +2349,23 @@ msgid "" "the tools in your toolbox." msgstr "" -#: ../../tutorials/intro.md:85 +#: ../../tutorials/intro.md:94 msgid "" "Diagram showing a sketch of a toolbox filled with different tools " "including a hammer and a saw." msgstr "" -#: ../../tutorials/intro.md:87 +#: ../../tutorials/intro.md:96 msgid "" "You can think about a package as a toolbox filled with coding tools. A " "tool may be a function or a class. Each tool does a specific thing well." msgstr "" -#: ../../tutorials/intro.md:92 +#: ../../tutorials/intro.md:101 msgid "Python packages are installable" msgstr "" -#: ../../tutorials/intro.md:94 +#: ../../tutorials/intro.md:103 msgid "" "A package is installable, which means that you can add the functionality " "within the package's code to any Python environment and import that " @@ -2325,7 +2373,7 @@ msgid "" "as NumPy or Matplotlib." msgstr "" -#: ../../tutorials/intro.md:103 +#: ../../tutorials/intro.md:112 msgid "" "Installing a package into an environment makes it easier to manage and " "reuse your code across different projects. Structuring your code as a " @@ -2333,15 +2381,15 @@ msgid "" "the toolbox you've created and let others build with it." msgstr "" -#: ../../tutorials/intro.md:108 +#: ../../tutorials/intro.md:117 msgid "Why create a Python package?" msgstr "" -#: ../../tutorials/intro.md:110 +#: ../../tutorials/intro.md:119 msgid "You might create a Python package because you want to:" msgstr "" -#: ../../tutorials/intro.md:112 +#: ../../tutorials/intro.md:121 msgid "" "**Use your code across different projects:** At its most basic level, " "creating a package allows you to install your code into a Python " @@ -2349,14 +2397,14 @@ msgid "" "any workflows both locally and in the cloud." msgstr "" -#: ../../tutorials/intro.md:113 +#: ../../tutorials/intro.md:122 msgid "" "**Share your code:** If you publish a package on a public repository such" " as PyPI or conda, your package can be installed on any machine using pip" " or conda with a single command." msgstr "" -#: ../../tutorials/intro.md:114 +#: ../../tutorials/intro.md:123 msgid "" "**Build community around your code:** Packages make it easier for " "multiple people to work on the same project (particularly when published " @@ -2367,7 +2415,7 @@ msgid "" "accepting changes to the code base." msgstr "" -#: ../../tutorials/intro.md:115 +#: ../../tutorials/intro.md:124 msgid "" "**Organize your code:** Packages can be used to organize large code " "projects, dividing them into smaller, more manageable components. This " @@ -2375,50 +2423,50 @@ msgid "" "easier to understand." msgstr "" -#: ../../tutorials/intro.md:117 +#: ../../tutorials/intro.md:126 msgid "What to consider before you create a package" msgstr "" -#: ../../tutorials/intro.md:119 +#: ../../tutorials/intro.md:128 msgid "" "Creating a Python package that others use takes considerable time and " "effort. Before you begin, think about your goals including:" msgstr "" -#: ../../tutorials/intro.md:122 +#: ../../tutorials/intro.md:131 msgid "Who you think will use your package" msgstr "" -#: ../../tutorials/intro.md:123 +#: ../../tutorials/intro.md:132 msgid "How people might use your package and on what data (if data are relevant)" msgstr "" -#: ../../tutorials/intro.md:124 +#: ../../tutorials/intro.md:133 msgid "Whether you have time to add things such as documentation and tests" msgstr "" -#: ../../tutorials/intro.md:125 +#: ../../tutorials/intro.md:134 msgid "" "How long you might be able to maintain it: remember that once people " "begin using your package they will depend on your maintainer team to " "update it, fix bugs and answer questions." msgstr "" -#: ../../tutorials/intro.md:127 +#: ../../tutorials/intro.md:136 msgid "" "Before creating a user-facing package, it's important to consider all of " "the above." msgstr "" -#: ../../tutorials/intro.md:129 +#: ../../tutorials/intro.md:138 msgid "The elements of a Python package" msgstr "" -#: ../../tutorials/intro.md:133 ../../tutorials/intro.md:211 +#: ../../tutorials/intro.md:142 ../../tutorials/intro.md:220 msgid "Diagram showing .. more here if this stays." msgstr "" -#: ../../tutorials/intro.md:135 +#: ../../tutorials/intro.md:144 msgid "" "The elements of a Python package include code, documentation, tests, an " "OSI-approved license and infrastructure. Maintainers are at the core " @@ -2426,43 +2474,43 @@ msgid "" "addressing user concerns." msgstr "" -#: ../../tutorials/intro.md:141 +#: ../../tutorials/intro.md:150 msgid "The core elements of Python package include:" msgstr "" -#: ../../tutorials/intro.md:143 +#: ../../tutorials/intro.md:152 msgid "" "**Code:** Functions and classes that provide functionality for a user of " "your package" msgstr "" -#: ../../tutorials/intro.md:144 +#: ../../tutorials/intro.md:153 msgid "" "**Documentation:** Installation instructions, tutorials, and examples " "that both help users get started using your package and contributors and " "maintainers fix bugs and maintain the package." msgstr "" -#: ../../tutorials/intro.md:145 +#: ../../tutorials/intro.md:154 msgid "" "Contributor Documentation in the form of a **CONTRIBUTING.md** file is " "useful to help people to contribute to your package." msgstr "" -#: ../../tutorials/intro.md:146 +#: ../../tutorials/intro.md:155 msgid "" "Development Documentation helps both maintainers and contributors " "understand how to maintain a package's infrastructure." msgstr "" -#: ../../tutorials/intro.md:147 +#: ../../tutorials/intro.md:156 msgid "" "**Tests:** that make sure your code works as it should and makes it " "easier for you and others to contribute to, modify and update the code in" " the future" msgstr "" -#: ../../tutorials/intro.md:148 +#: ../../tutorials/intro.md:157 msgid "" "**License:** An open source license, or license that is [OSI " "approved](https://opensource.org/licenses/), refers to an license that " @@ -2470,7 +2518,7 @@ msgid "" "regarding how elements of the package can and can't be reused." msgstr "" -#: ../../tutorials/intro.md:149 +#: ../../tutorials/intro.md:158 msgid "" "**Infrastructure** that automates updates, publication workflows and runs" " test suites. Infrastructure includes a suite of things such as platforms" @@ -2479,11 +2527,11 @@ msgid "" "steps." msgstr "" -#: ../../tutorials/intro.md:151 +#: ../../tutorials/intro.md:160 msgid "What pyOpenSci looks for in a package" msgstr "" -#: ../../tutorials/intro.md:154 +#: ../../tutorials/intro.md:163 msgid "" "pyOpenSci performs an [initial set of editor " "checks](https://www.pyopensci.org/software-peer-review/how-to/editor-in-" @@ -2492,11 +2540,11 @@ msgid "" "package as a baseline for things that you package should have." msgstr "" -#: ../../tutorials/intro.md:160 +#: ../../tutorials/intro.md:169 msgid "Packages are more than just code - Infrastructure" msgstr "" -#: ../../tutorials/intro.md:162 +#: ../../tutorials/intro.md:171 msgid "" "A package in any language is more than just code. If you expect other " "people to use your package, besides yourself, you should consider not " @@ -2504,11 +2552,11 @@ msgid "" "package that make it a useful community resource." msgstr "" -#: ../../tutorials/intro.md:167 +#: ../../tutorials/intro.md:176 msgid "Version control and storing your package on GitHub or GitLab" msgstr "" -#: ../../tutorials/intro.md:169 +#: ../../tutorials/intro.md:178 msgid "" "Most Python packages live in an online version control platform such as " "GitHub or GitLab. GitHub and GitLab both run [git](https://git-scm.com/) " @@ -2518,7 +2566,7 @@ msgid "" "to the code base unexpectedly breaks something." msgstr "" -#: ../../tutorials/intro.md:174 +#: ../../tutorials/intro.md:183 msgid "" "By publishing your package on GitHub or GitLab, you are making your code " "public facing. This means that others can both see your code and also " @@ -2526,11 +2574,11 @@ msgid "" " / code review workflow." msgstr "" -#: ../../tutorials/intro.md:176 +#: ../../tutorials/intro.md:185 msgid "GitHub & GitLab vs. Git" msgstr "" -#: ../../tutorials/intro.md:179 +#: ../../tutorials/intro.md:188 msgid "" "GitHub and GitLab are online (cloud) platforms that run `git` (version " "control software) on the backend. Running git locally on your computer " @@ -2538,35 +2586,35 @@ msgid "" "GitHub and GitLab." msgstr "" -#: ../../tutorials/intro.md:184 +#: ../../tutorials/intro.md:193 msgid "Issues or Ticket Trackers" msgstr "" -#: ../../tutorials/intro.md:186 +#: ../../tutorials/intro.md:195 msgid "" "GitHub and GitLab also both offer community features such as issues that " "allow:" msgstr "" -#: ../../tutorials/intro.md:188 +#: ../../tutorials/intro.md:197 msgid "you to communicate with your maintainers and contributor community" msgstr "" -#: ../../tutorials/intro.md:189 +#: ../../tutorials/intro.md:198 msgid "users to report bugs, ask questions and request new features" msgstr "" -#: ../../tutorials/intro.md:190 +#: ../../tutorials/intro.md:199 msgid "" "you to publicly keep track of enhancements and features you want to work " "on for your package." msgstr "" -#: ../../tutorials/intro.md:192 +#: ../../tutorials/intro.md:201 msgid "Continuous integration and continuous deployment" msgstr "" -#: ../../tutorials/intro.md:194 +#: ../../tutorials/intro.md:203 msgid "" "GitHub and GitLab also provide continuous integration and continuous " "deployment (CI/CD). Continuous integration (CI) refers to a platform that" @@ -2575,29 +2623,29 @@ msgid "" "running or building but also to publishing the final outputs somewhere." msgstr "" -#: ../../tutorials/intro.md:196 +#: ../../tutorials/intro.md:205 msgid "**An example of Continuous integration:**" msgstr "" -#: ../../tutorials/intro.md:198 +#: ../../tutorials/intro.md:207 msgid "" "When someone submits a change to your code, your tests will run across " "different operating systems and the code will be checked for format " "issues." msgstr "" -#: ../../tutorials/intro.md:200 +#: ../../tutorials/intro.md:209 msgid "**An example of Continuous deployment:**" msgstr "" -#: ../../tutorials/intro.md:202 +#: ../../tutorials/intro.md:211 msgid "" "When you are ready to release your package to PyPI, a continuous " "deployment operation might be triggered on release to publish your " "package to PyPI." msgstr "" -#: ../../tutorials/intro.md:204 +#: ../../tutorials/intro.md:213 msgid "" "Integrated CI/CD will help you maintain your software, ensuring that " "changes to the code don't break things unexpectedly. They can also help " @@ -2605,25 +2653,25 @@ msgid "" "your code." msgstr "" -#: ../../tutorials/intro.md:213 +#: ../../tutorials/intro.md:222 msgid "The lifecycle of a scientific Python package." msgstr "" -#: ../../tutorials/intro.md:216 +#: ../../tutorials/intro.md:225 msgid "When should you turn your code into a Python package?" msgstr "" -#: ../../tutorials/intro.md:218 +#: ../../tutorials/intro.md:227 msgid "" "You may be wondering, what types of code should become a Python package " "that is both on GitHub and published to PyPI and/or conda-forge." msgstr "" -#: ../../tutorials/intro.md:220 +#: ../../tutorials/intro.md:229 msgid "There are a few use cases to consider:" msgstr "" -#: ../../tutorials/intro.md:222 +#: ../../tutorials/intro.md:231 msgid "" "**Creating a basic package for yourself:** Sometimes you want create a " "package for your own personal use. This might mean making your code " @@ -2633,18 +2681,18 @@ msgid "" "update the package." msgstr "" -#: ../../tutorials/intro.md:224 +#: ../../tutorials/intro.md:233 msgid "" "An example of this type of package might be a set of functions that you " "write that are useful across several of your projects. It could be useful" " to have those functions available to all of your projects." msgstr "" -#: ../../tutorials/intro.md:227 +#: ../../tutorials/intro.md:236 msgid "LINK to pip installable lesson when it's published - it's in review now" msgstr "" -#: ../../tutorials/intro.md:230 +#: ../../tutorials/intro.md:239 msgid "" "**Creating a package for the community:** In other cases, you may create " "some code that you soon realize might also be useful to not just you, but" @@ -2657,25 +2705,25 @@ msgid "" " published to PyPI." msgstr "" -#: ../../tutorials/intro.md:233 +#: ../../tutorials/intro.md:242 msgid "" "For example, all of the [pyOpenSci packages](https://www.pyopensci.org" "/python-packages.html) are public facing with an intended audience beyond" " just the maintainers." msgstr "" -#: ../../tutorials/intro.md:235 +#: ../../tutorials/intro.md:244 msgid "Packages that you expect others to use should be well-scoped" msgstr "" -#: ../../tutorials/intro.md:237 +#: ../../tutorials/intro.md:246 msgid "" "Ideally the code in your Python package is focused on a specific theme or" " use case. This theme is important as it's a way to scope the content of " "your package." msgstr "" -#: ../../tutorials/intro.md:239 +#: ../../tutorials/intro.md:248 msgid "" "It can be tricky to decide when your code becomes something that might be" " more broadly useful to others. But one question you can ask yourself is " @@ -2684,11 +2732,11 @@ msgid "" "domain?" msgstr "" -#: ../../tutorials/intro.md:241 +#: ../../tutorials/intro.md:250 msgid "How does this relate to code for a research project?" msgstr "" -#: ../../tutorials/intro.md:244 +#: ../../tutorials/intro.md:253 msgid "" "A [Research Compendium](https://the-turing-way.netlify.app/reproducible-" "research/compendia.html) is an organized set of code, data and " @@ -2697,7 +2745,7 @@ msgid "" "comprehensive record of the methods, data, and analyses used in a study." msgstr "" -#: ../../tutorials/intro.md:249 +#: ../../tutorials/intro.md:258 msgid "" "A Python package is a collection of modules that can be used to perform a" " specific set of tasks. These tasks should be applicable to numerous " @@ -2705,24 +2753,24 @@ msgid "" " Compendium which supports a specific project." msgstr "" -#: ../../tutorials/intro.md:254 +#: ../../tutorials/intro.md:263 msgid "" "[Read about `Good enough practices in scientific " "computing`](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510)" msgstr "" -#: ../../tutorials/intro.md:255 +#: ../../tutorials/intro.md:264 msgid "" "[Learn more about research compendia (also called repo-packs) in this " "blog post.](https://lorenabarba.com/blog/how-repro-packs-can-save-your-" "future-self/)" msgstr "" -#: ../../tutorials/intro.md:258 +#: ../../tutorials/intro.md:267 msgid "Below are a few examples well scoped pyOpenSci packages:" msgstr "" -#: ../../tutorials/intro.md:260 +#: ../../tutorials/intro.md:269 msgid "" "[Crowsetta](https://crowsetta.readthedocs.io/en/latest/): is a package " "designed to work with annotating animal vocalizations and bioacoustics " @@ -2731,28 +2779,28 @@ msgid "" "application associated with a user-specific research workflow." msgstr "" -#: ../../tutorials/intro.md:261 +#: ../../tutorials/intro.md:270 msgid "" "[Pandera](https://www.union.ai/pandera) is another more broadly used " "Python package. Pandera supports data testing and thus also has a broader" " research application." msgstr "" -#: ../../tutorials/intro.md:263 +#: ../../tutorials/intro.md:272 msgid "Matplotlib as an example" msgstr "" -#: ../../tutorials/intro.md:265 +#: ../../tutorials/intro.md:274 msgid "" "At the larger end of the user spectrum, Matplotlib is a great example. " "Matplotlib does one thing really well:" msgstr "" -#: ../../tutorials/intro.md:268 +#: ../../tutorials/intro.md:277 msgid "_It creates visual plots of data._" msgstr "" -#: ../../tutorials/intro.md:270 +#: ../../tutorials/intro.md:279 msgid "" "Thousands of people use Matplotlib for different plotting applications " "using different types of data. While few scientific packages will have " @@ -2760,24 +2808,24 @@ msgid "" "idea of scoping out what your package does is still important." msgstr "" -#: ../../tutorials/intro.md:276 +#: ../../tutorials/intro.md:285 msgid "Code should also be clean & readable & documented" msgstr "" -#: ../../tutorials/intro.md:278 +#: ../../tutorials/intro.md:287 msgid "" "The code in your package should also be clean, readable, and well " "documented." msgstr "" -#: ../../tutorials/intro.md:280 +#: ../../tutorials/intro.md:289 msgid "" "**Clean code:** Clean code refers to code that uses expressive variable " "names, is concise and doesn't repeat itself. You can learn about best " "practices for clean code in future pyOpenSci tutorials." msgstr "" -#: ../../tutorials/intro.md:284 +#: ../../tutorials/intro.md:293 msgid "" "**Readable code:** readable code is code written with a consistent style." " You can use linters and code formatters such as black and flake8 to " @@ -2786,7 +2834,7 @@ msgid "" "format)" msgstr "" -#: ../../tutorials/intro.md:288 +#: ../../tutorials/intro.md:297 msgid "" "**Documented code:** documented code is written using docstrings that " "help a user understand both what the functions and methods in your code " @@ -2795,15 +2843,15 @@ msgid "" "/write-user-documentation/document-your-code-api-docstrings)" msgstr "" -#: ../../tutorials/intro.md:292 +#: ../../tutorials/intro.md:301 msgid "Making your package installable - publishing to PyPI & conda-forge" msgstr "" -#: ../../tutorials/intro.md:294 +#: ../../tutorials/intro.md:303 msgid "Python packages and environments" msgstr "" -#: ../../tutorials/intro.md:296 +#: ../../tutorials/intro.md:305 msgid "" "You can install a Python package into a Python environment in the same " "way you might install NumPy or Pandas. Installing your package into an " @@ -2811,7 +2859,7 @@ msgid "" "Python environment activated." msgstr "" -#: ../../tutorials/intro.md:302 +#: ../../tutorials/intro.md:311 msgid "" "Diagram showing the steps associated with creating a package and then " "installing it. The first arrow says your package and the second says pip " @@ -2821,7 +2869,7 @@ msgid "" "when you pip install it." msgstr "" -#: ../../tutorials/intro.md:304 +#: ../../tutorials/intro.md:313 msgid "" "You don't have to publish to PyPI to make your code installable. With the" " correct file structure and project metadata you can make your code " @@ -2831,49 +2879,49 @@ msgid "" "others." msgstr "" -#: ../../tutorials/intro.md:311 +#: ../../tutorials/intro.md:320 msgid "Publishing a package to PyPI / Conda-Forge" msgstr "" -#: ../../tutorials/intro.md:313 +#: ../../tutorials/intro.md:322 msgid "" "If you want to make your package directly installable without having to " "download the code to your computer locally then you need to publish it in" " a repository such as **PyPI** or **conda-forge**." msgstr "" -#: ../../tutorials/intro.md:317 +#: ../../tutorials/intro.md:326 msgid "" "Learn [how to publish your package to PyPI in this tutorial.](publish-" "pypi.md)" msgstr "" -#: ../../tutorials/intro.md:319 +#: ../../tutorials/intro.md:328 msgid "" "Then you can create a conda-forge recipe using the " "[Grayskull](https://github.com/conda/grayskull) tool. You can then submit" " this recipe to conda-forge." msgstr "" -#: ../../tutorials/intro.md:321 +#: ../../tutorials/intro.md:330 msgid "" "[You will learn more about the conda-forge publication process here" ".](publish-conda-forge.md)" msgstr "" -#: ../../tutorials/intro.md:324 +#: ../../tutorials/intro.md:333 msgid "" "Graphic showing the high level packaging workflow. On the left you see a " "graphic with code, metadata and tests in it. Those items all go into your" " package. Documentation and data are below that box because they aren't " -"normally published in your packaging wheel distribution. an arrow to the " -"right takes you to a build distribution files box. that box leads you to " +"normally published in your packaging wheel distribution. An arrow to the " +"right takes you to a build distribution files box. That box leads you to " "either publishing to TestPyPI or the real PyPI. From PyPI you can then " "connect to conda-forge for an automated build that sends distributions " "from PyPI to conda-forge." msgstr "" -#: ../../tutorials/intro.md:326 +#: ../../tutorials/intro.md:335 msgid "" "In the image above, you can see the steps associated with publishing your" " package on PyPI and conda-forge. Note that the distribution files that " @@ -2886,11 +2934,11 @@ msgid "" "forge lesson](/tutorials/publish-conda-forge)." msgstr "" -#: ../../tutorials/intro.md:330 +#: ../../tutorials/intro.md:339 msgid "Yay, your package has users! Now what?" msgstr "" -#: ../../tutorials/intro.md:332 +#: ../../tutorials/intro.md:341 msgid "" "As the community using your package grows, you may also find yourself " "managing users, contributors, and others who want to interact with your " @@ -2900,34 +2948,34 @@ msgid "" "use it." msgstr "" -#: ../../tutorials/intro.md:334 +#: ../../tutorials/intro.md:343 msgid "To support your community, you'll want to add things like:" msgstr "" -#: ../../tutorials/intro.md:336 +#: ../../tutorials/intro.md:345 msgid "" "[a development guide that documents your maintainer workflow process " "](/documentation/repository-files/development-guide.md)" msgstr "" -#: ../../tutorials/intro.md:337 +#: ../../tutorials/intro.md:346 msgid "" "[a code of conduct to defines community interaction standards and " "expectations](/documentation/repository-files/code-of-conduct-file.md)" msgstr "" -#: ../../tutorials/intro.md:338 +#: ../../tutorials/intro.md:347 msgid "" "[a contributing guide that helps users understand expectations associated" " with making contributions to your project](/documentation/repository-" "files/contributing-file.md)" msgstr "" -#: ../../tutorials/intro.md:340 +#: ../../tutorials/intro.md:349 msgid "Support for contributors and maintainers" msgstr "" -#: ../../tutorials/intro.md:342 +#: ../../tutorials/intro.md:351 msgid "" "If you intend for others to use and contribute to your code, consider who" " will maintain it over time. You will want a **contributing and " @@ -2937,7 +2985,7 @@ msgid "" "and maintainer team." msgstr "" -#: ../../tutorials/intro.md:344 +#: ../../tutorials/intro.md:353 msgid "" "The elements above are also important for future maintenance of your " "package. In the case that you are no long able to maintain it or simply " @@ -2945,11 +2993,11 @@ msgid "" "you onboard new maintainers." msgstr "" -#: ../../tutorials/intro.md:349 +#: ../../tutorials/intro.md:358 msgid "What's next?" msgstr "" -#: ../../tutorials/intro.md:351 +#: ../../tutorials/intro.md:360 msgid "" "In future lessons you will learn more about the infrastructure around a " "published Python package that makes it both easier to maintain, easier " @@ -2958,7 +3006,7 @@ msgid "" "Python package." msgstr "" -#: ../../tutorials/intro.md:353 +#: ../../tutorials/intro.md:362 msgid "" "In this next lesson you will learn how to create a basic installable " "Python package. Make your code pip installable " @@ -3038,7 +3086,7 @@ msgstr "" msgid "" "Image showing the progression of creating a Python package, building it " "and then publishing to PyPI and conda-forge. You take your code and turn " -"it into distribution files (sdist and wheel) that PyPI accepts. then " +"it into distribution files (sdist and wheel) that PyPI accepts. Then " "there is an arrow towards the PyPI repository where ou publish both " "distributions. From PyPI if you create a conda-forge recipe you can then " "publish to conda-forge." @@ -3386,7 +3434,7 @@ msgstr "" #: ../../tutorials/publish-conda-forge.md:279 msgid "" "There is currently a small bug in Grayskull where it doesn't populate the" -" home: element of the recipe. if you don't include this, [you will " +" home: element of the recipe. If you don't include this, [you will " "receive an error message](https://github.com/conda-forge/staged-" "recipes/pull/25173#issuecomment-1917916528) from the friendly conda-forge" " linter bot." @@ -3934,8 +3982,8 @@ msgstr "" #: ../../tutorials/publish-pypi.md:60 msgid "" "In a future lesson, you will learn how to create an automated GitHub " -"action workflow that publishes an updated version of your package to PyPI" -" every time you create a GitHub release." +"Actions workflow that publishes an updated version of your package to " +"PyPI every time you create a GitHub release." msgstr "" #: ../../tutorials/publish-pypi.md:64 @@ -4192,7 +4240,7 @@ msgid "Recommended" msgstr "" #: ../../tutorials/publish-pypi.md:221 -msgid "Update the Github repository name to align with the new package name" +msgid "Update the GitHub repository name to align with the new package name" msgstr "" #: ../../tutorials/publish-pypi.md:222 @@ -4472,10 +4520,10 @@ msgstr "" #: ../../tutorials/publish-pypi.md:363 msgid "" "You can also create an automated publication workflow on GitHub using " -"GitHub actions. This is a great way to make the publication process " +"GitHub Actions. This is a great way to make the publication process " "easier and it also supports a growing maintainer team. In this case we " "suggest you don't worry about the token and instead setup a specific " -"GitHub action that publishes your package when you make a release. You " +"GitHub Actions that publishes your package when you make a release. You " "can then create a \"trusted publisher\" workflow on PyPI." msgstr "" @@ -4665,7 +4713,7 @@ msgstr "" #: ../../tutorials/pyproject-toml.md:43 msgid "" "When you are adding classifiers to the **[project]** table, only use " -"valid values from [PyPI’s classifier " +"valid values from [PyPI's classifier " "page](https://PyPI.org/classifiers/). An invalid value here will raise an" " error when you build and publish your package on PyPI." msgstr "" @@ -5534,3 +5582,158 @@ msgid "" "existing functionality remains intact. Run any pre-existing tests to " "verify that everything still works as expected." msgstr "" + +#~ msgid "" +#~ "create a `LICENSE` file in your " +#~ "project directory that specifies the " +#~ "license that you choose for your " +#~ "package and" +#~ msgstr "" + +#~ msgid "" +#~ "reference that file in your " +#~ "`pyproject.toml` data where metadata are " +#~ "set." +#~ msgstr "" + +#~ msgid "" +#~ "`hatch config show` will print out " +#~ "the contents of your `config.toml` file" +#~ " in your shell. look at the " +#~ "values and ensure that your name, " +#~ "email is set. Also make sure that" +#~ " `tests=false`." +#~ msgstr "" + +#~ msgid "" +#~ "it will convert metadata stored in " +#~ "a `setup.py` or `setup.cfg` file to " +#~ "a pyproject.toml file for you (see " +#~ "[Migrating setup.py to pyproject.toml using" +#~ " Hatch](setup-py-to-pyproject-toml.md " +#~ "))" +#~ msgstr "" + +#~ msgid "" +#~ "ADD: note about what makes something " +#~ "\"package worthy\", with a common " +#~ "misconception being that a package " +#~ "should be production-ready code that's" +#~ " valuable to a broad audience. this" +#~ " may not be a pervasive misconception" +#~ " in Python, but a quick break-" +#~ "out with an explanation of what a" +#~ " package can consist of would be " +#~ "helpful." +#~ msgstr "" + +#~ msgid "" +#~ "The directory structure you’ll create in" +#~ " this lesson will look like this:" +#~ msgstr "" + +#~ msgid "" +#~ "Where you define your project’s metadata" +#~ " (including its name, authors, license, " +#~ "etc)" +#~ msgstr "" + +#~ msgid "" +#~ "If you aren’t familiar with docstrings" +#~ " or typing yet, that is ok. You" +#~ " can review [this page in the " +#~ "pyOpenSci packaging guide](https://www.pyopensci.org" +#~ "/python-package-guide/documentation/write-user-" +#~ "documentation/document-your-code-api-" +#~ "docstrings.html) for an overview of both" +#~ " topics." +#~ msgstr "" + +#~ msgid "" +#~ "Once you have your project metadata " +#~ "in the pyproject.toml file, you will " +#~ "rarely update it. In the next " +#~ "lesson you’ll add more metadata and " +#~ "structure to this file." +#~ msgstr "" + +#~ msgid "" +#~ "Graphic showing the high level packaging" +#~ " workflow. On the left you see " +#~ "a graphic with code, metadata and " +#~ "tests in it. Those items all go" +#~ " into your package. Documentation and " +#~ "data are below that box because " +#~ "they aren't normally published in your" +#~ " packaging wheel distribution. an arrow " +#~ "to the right takes you to a " +#~ "build distribution files box. that box" +#~ " leads you to either publishing to" +#~ " TestPyPI or the real PyPI. From " +#~ "PyPI you can then connect to " +#~ "conda-forge for an automated build " +#~ "that sends distributions from PyPI to" +#~ " conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "Image showing the progression of " +#~ "creating a Python package, building it" +#~ " and then publishing to PyPI and " +#~ "conda-forge. You take your code " +#~ "and turn it into distribution files " +#~ "(sdist and wheel) that PyPI accepts. " +#~ "then there is an arrow towards the" +#~ " PyPI repository where ou publish " +#~ "both distributions. From PyPI if you " +#~ "create a conda-forge recipe you " +#~ "can then publish to conda-forge." +#~ msgstr "" + +#~ msgid "" +#~ "There is currently a small bug in" +#~ " Grayskull where it doesn't populate " +#~ "the home: element of the recipe. " +#~ "if you don't include this, [you " +#~ "will receive an error " +#~ "message](https://github.com/conda-forge/staged-" +#~ "recipes/pull/25173#issuecomment-1917916528) from the " +#~ "friendly conda-forge linter bot." +#~ msgstr "" + +#~ msgid "" +#~ "In a future lesson, you will learn" +#~ " how to create an automated GitHub" +#~ " action workflow that publishes an " +#~ "updated version of your package to " +#~ "PyPI every time you create a " +#~ "GitHub release." +#~ msgstr "" + +#~ msgid "Update the Github repository name to align with the new package name" +#~ msgstr "" + +#~ msgid "" +#~ "You can also create an automated " +#~ "publication workflow on GitHub using " +#~ "GitHub actions. This is a great " +#~ "way to make the publication process " +#~ "easier and it also supports a " +#~ "growing maintainer team. In this case" +#~ " we suggest you don't worry about " +#~ "the token and instead setup a " +#~ "specific GitHub action that publishes " +#~ "your package when you make a " +#~ "release. You can then create a " +#~ "\"trusted publisher\" workflow on PyPI." +#~ msgstr "" + +#~ msgid "" +#~ "When you are adding classifiers to " +#~ "the **[project]** table, only use valid" +#~ " values from [PyPI’s classifier " +#~ "page](https://PyPI.org/classifiers/). An invalid " +#~ "value here will raise an error " +#~ "when you build and publish your " +#~ "package on PyPI." +#~ msgstr ""