diff --git a/.doctrees/documentation/index.doctree b/.doctrees/documentation/index.doctree index 685299ab..72d06557 100644 Binary files a/.doctrees/documentation/index.doctree and b/.doctrees/documentation/index.doctree differ diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle index 47f91f6b..55f68087 100644 Binary files a/.doctrees/environment.pickle and b/.doctrees/environment.pickle differ diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree index 2908e4f8..42194b1e 100644 Binary files a/.doctrees/index.doctree and b/.doctrees/index.doctree differ diff --git a/.doctrees/package-structure-code/intro.doctree b/.doctrees/package-structure-code/intro.doctree index a05e08e4..31bae87c 100644 Binary files a/.doctrees/package-structure-code/intro.doctree and b/.doctrees/package-structure-code/intro.doctree differ diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index e71b2b69..8f248c73 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -202,69 +202,6 @@
-
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -431,69 +368,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website diff --git a/_sources/documentation/index.md.txt b/_sources/documentation/index.md.txt index e2507376..23d1aa71 100644 --- a/_sources/documentation/index.md.txt +++ b/_sources/documentation/index.md.txt @@ -43,7 +43,6 @@ Publish Your Docs Website Hosting and Optimization ``` - ```{important} Please note that the tools discussed here are those that we see commonly used in the community. As tools evolve we @@ -104,13 +103,13 @@ Python workflows. They might be new(er) to Python and/or data science. Or expert programmers. But they might not have a background in software development. These users need to know: - * How to install your package - * How to install dependencies that your package requires - * How to get started using the code base - * Information on how to cite your code / give you credit if they are using it - in a research application. - * Information on the license that your code uses so they know how they can - or can't use the code in an operational setting. +- How to install your package +- How to install dependencies that your package requires +- How to get started using the code base +- Information on how to cite your code / give you credit if they are using it + in a research application. +- Information on the license that your code uses so they know how they can + or can't use the code in an operational setting. ### 2. Potential tool contributors @@ -118,16 +117,16 @@ The other subset of users are more experienced and/or more engaged with your package. As such they are potential contributors. These users: -* might have a software development background, -* might also be able to contribute bug fixes to your package or updates to your documentation -* might also just be users who will find spelling errors in your documentation, or bugs in your tutorials. +- might have a software development background, +- might also be able to contribute bug fixes to your package or updates to your documentation +- might also just be users who will find spelling errors in your documentation, or bugs in your tutorials. These users need all of the things that a basic user needs. But, they also need to understand how you'd like for them to contribute to your package. These potential contributors need: -* A development guide to help them understand the infrastructure used in your package repository. -* Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted. +- A development guide to help them understand the infrastructure used in your package repository. +- Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted. ```{important} It's important to remember that the definition of what a contribution is can be @@ -136,7 +135,6 @@ 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. ``` - ## Documentation elements that pyOpenSci looks for reviewing a Python package In the pyOpenSci open peer review, we look for @@ -149,12 +147,12 @@ that you should consider in your package's documentation in more detail. - ```{button-link} https://www.pyopensci.org/software-peer-review/how-to/editor-in-chief-guide.html#editor-checklist-template :color: primary :class: sd-rounded-pill float-left View pyOpenSci peer review check list ``` +

    previous

    -

    Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud

    -
    -     - -
    -

    next

    -

    Python Packaging Tools… Coming soon…

    +

    Python Package Code Style, Format and Linters

    -
    • diff --git a/documentation/hosting-tools/intro.html b/documentation/hosting-tools/intro.html index 120c70ff..1943a481 100644 --- a/documentation/hosting-tools/intro.html +++ b/documentation/hosting-tools/intro.html @@ -178,7 +178,7 @@

    Publishing a package

     diff --git a/package-structure-code/python-package-structure.html b/package-structure-code/python-package-structure.html index 00bc9edf..2a6ecb42 100644 --- a/package-structure-code/python-package-structure.html +++ b/package-structure-code/python-package-structure.html @@ -204,69 +204,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -433,69 +370,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -598,9 +472,9 @@

    Publishing a package
    • diff --git a/package-structure-code/python-package-versions.html b/package-structure-code/python-package-versions.html index 4378347b..5cabfadf 100644 --- a/package-structure-code/python-package-versions.html +++ b/package-structure-code/python-package-versions.html @@ -82,7 +82,7 @@ - + @@ -204,69 +204,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -433,69 +370,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -598,9 +472,9 @@

    Publishing a package
    • @@ -973,12 +847,12 @@

    Python Semantic Release Cons

    previous

    -

    Complex Python package builds

    +

    Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud

     - @@ -203,69 +202,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -432,69 +368,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -654,15 +527,6 @@

    Python Packaging Tools… Coming soon…
    - - -
    -

    previous

    -

    CI and Testing - Coming Soon!

    -
    -

    • diff --git a/search.html b/search.html index e32f2a93..977b0da3 100644 --- a/search.html +++ b/search.html @@ -192,69 +192,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website @@ -417,69 +354,6 @@
    -
  • - - Documentation Overview - -
    • - - -
  • - - Write User Documentation - -
    • - - -
  • - - Core GitHub Repository Files - -
    • - - -
  • - - Documentation Tools & Hosting - -
    • - - -
  • - - Manage Package Versions - -
    • - - -
  • - - Publish Package PyPI Conda - -
    • - - -
  • - - Code Style & Format - -
    • - - -
  • - - Intro - -
    • - - -
  • - - Intro - -
    • - -
  • pyOpenSci Website diff --git a/searchindex.js b/searchindex.js index 3d4fc3c2..1316f32b 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["CONTRIBUTING", "ci-and-testing/intro", "documentation/hosting-tools/intro", "documentation/hosting-tools/myst-markdown-rst-doc-syntax", "documentation/hosting-tools/publish-documentation-online", "documentation/hosting-tools/sphinx-python-package-documentation-tools", "documentation/hosting-tools/website-hosting-optimizing-your-docs", "documentation/index", "documentation/repository-files/code-of-conduct-file", "documentation/repository-files/contributing-file", "documentation/repository-files/development-guide", "documentation/repository-files/intro", "documentation/repository-files/license-files", "documentation/repository-files/readme-file-best-practices", "documentation/write-user-documentation/create-package-tutorials", "documentation/write-user-documentation/document-your-code-api-docstrings", "documentation/write-user-documentation/get-started", "documentation/write-user-documentation/intro", "index", "package-structure-code/code-style-linting-format", "package-structure-code/complex-python-package-builds", "package-structure-code/intro", "package-structure-code/publish-python-package-pypi-conda", "package-structure-code/pyproject-toml-python-package-metadata", "package-structure-code/python-package-build-tools", "package-structure-code/python-package-distribution-files-sdist-wheel", "package-structure-code/python-package-structure", "package-structure-code/python-package-versions", "python-packaging/intro"], "filenames": ["CONTRIBUTING.md", "ci-and-testing/intro.md", "documentation/hosting-tools/intro.md", "documentation/hosting-tools/myst-markdown-rst-doc-syntax.md", "documentation/hosting-tools/publish-documentation-online.md", "documentation/hosting-tools/sphinx-python-package-documentation-tools.md", "documentation/hosting-tools/website-hosting-optimizing-your-docs.md", "documentation/index.md", "documentation/repository-files/code-of-conduct-file.md", "documentation/repository-files/contributing-file.md", "documentation/repository-files/development-guide.md", "documentation/repository-files/intro.md", "documentation/repository-files/license-files.md", "documentation/repository-files/readme-file-best-practices.md", "documentation/write-user-documentation/create-package-tutorials.md", "documentation/write-user-documentation/document-your-code-api-docstrings.md", "documentation/write-user-documentation/get-started.md", "documentation/write-user-documentation/intro.md", "index.md", "package-structure-code/code-style-linting-format.md", "package-structure-code/complex-python-package-builds.md", "package-structure-code/intro.md", "package-structure-code/publish-python-package-pypi-conda.md", "package-structure-code/pyproject-toml-python-package-metadata.md", "package-structure-code/python-package-build-tools.md", "package-structure-code/python-package-distribution-files-sdist-wheel.md", "package-structure-code/python-package-structure.md", "package-structure-code/python-package-versions.md", "python-packaging/intro.md"], "titles": ["Contributing Guide for the Python open source software packaging book", "CI and Testing - Coming Soon!", "Tools to Build and Host your Documentation", "Documentation syntax: markdown vs. myST vs. rst syntax to create your docs", "How to publish your Python package documentation online", "Using Sphinx to Build Python Package Documentation", "Optimizing your documentation so search engines (and other users) find it", "Documentation for your Open Source Python Package", "The CODE_OF_CONDUCT.md file In Your Python Open Source Package", "Contributing File in your Python Open Source Package", "What the development guide for your Python package should contain", "Documentation Files That Should be in your Python Package Repository", "Your repository should have a LICENSE.md file", "README File Guidelines and Resources", "Create tutorials in your Python package documentation", "Document the code in your package\u2019s API using docstrings", "Create User Facing Documentation for your Python Package", "Writing user-facing documentation for your Python package", "pyOpenSci Python Open Source Package Development Guide", "Python Package Code Style, Format and Linters", "Complex Python package builds", "Python package structure information", "Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud", "Use a pyproject.toml file for your package configuration & metadata", "Python Package Build Tools", "The Python Package Source and Wheel Distributions", "Python Package Structure for Scientific Python Projects", "Creating New Versions of Your Python Package", "Python Packaging Tools\u2026 Coming soon\u2026"], "terms": {"i": [0, 1, 2, 3, 5, 6, 8, 11, 12, 13, 14, 16, 19, 20, 21, 24, 25, 26, 27, 28], "commun": [0, 5, 6, 7, 8, 11, 16, 18, 21, 24, 26], "resourc": [0, 18, 20, 23], "we": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28], "welcom": [0, 5, 7, 9], "form": 0, "issu": [0, 6, 7, 9, 16, 18, 19, 20, 24, 26], "pull": [0, 4, 9, 10, 14, 19, 22], "request": [0, 4, 9, 10, 14, 19, 22, 24], "If": [0, 3, 4, 6, 7, 8, 10, 12, 13, 14, 15, 18, 19, 20, 21, 24, 25, 26, 27], "you": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 13, 15, 16, 17, 19, 20, 23, 25, 26], "have": [0, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 25, 26, 27], "an": [0, 3, 6, 7, 10, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 23, 25, 26, 27], "idea": [0, 18], "someth": [0, 7], "should": [0, 1, 7, 8, 14, 15, 16, 17, 18, 19, 22, 24], "includ": [0, 2, 4, 5, 7, 8, 9, 10, 13, 14, 15, 16, 18, 19, 22, 23, 24, 25, 27], "pleas": [0, 7, 13, 20, 21], "here": [0, 5, 7, 8, 12, 13, 16, 17, 18, 19, 22, 23, 25, 26, 27], "find": [0, 3, 7, 13, 15, 16, 19, 22, 24, 27], "typo": 0, "feel": [0, 15], "free": [0, 4, 5, 6, 18], "submit": [0, 6, 7, 9, 10, 13, 18, 19, 21], "modifi": [0, 14, 19, 27], "text": [0, 3, 8, 10, 14, 15, 18, 27], "directli": [0, 19, 22, 24, 25, 26], "Or": [0, 7, 16, 22], "ar": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 27], "less": [0, 13, 14, 19, 24], "comfort": [0, 3, 8], "want": [0, 3, 4, 5, 6, 8, 13, 14, 15, 18, 19, 20, 22, 26, 27], "see": [0, 5, 7, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 26, 27], "larger": [0, 26], "chang": [0, 10, 18, 19, 22, 24, 26, 27], "content": [0, 6, 7, 13, 25, 27], "first": [0, 13, 23, 24, 25, 26], "most": [0, 2, 3, 5, 6, 18, 21, 22, 24, 27], "repositori": [0, 4, 7, 8, 9, 10, 13, 19, 23, 24, 25, 26, 27, 28], "sphinx": [0, 2, 3, 15, 16, 17], "engin": 0, "built": [0, 6, 19, 22, 24, 25, 27, 28], "us": [0, 2, 3, 4, 6, 7, 8, 10, 11, 12, 16, 18, 20, 21, 22, 25], "theme": [0, 6], "myst": [0, 2, 5, 16], "syntax": [0, 2, 5, 16, 18, 19], "creat": [0, 4, 5, 8, 10, 13, 15, 17, 19, 21, 22, 24, 25, 26], "each": [0, 6, 7, 8, 14, 15, 16, 18, 19, 21, 23, 24], "page": [0, 5, 6, 13, 14, 15, 18, 20, 21, 22, 24, 26], "wish": [0, 4, 7, 10, 19, 20, 24], "work": [0, 4, 10, 14, 15, 18, 19, 22, 23, 24, 26, 27], "need": [0, 3, 4, 7, 10, 14, 15, 16, 19, 20, 21, 23, 24, 25, 27], "fork": [0, 22], "clone": 0, "The": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 22, 23, 24, 27], "easiest": [0, 21], "wai": [0, 2, 4, 13, 16, 19, 21, 24, 25, 27], "nox": [0, 24], "tool": [0, 3, 5, 6, 8, 12, 13, 14, 15, 16, 18, 20, 21, 22, 23, 26], "quickli": [0, 4, 13, 14, 15, 16], "environ": [0, 4, 10, 14, 19, 22, 24, 25, 26], "run": [0, 4, 5, 10, 24, 25, 26, 27], "command": [0, 15, 19, 24, 27], "within": [0, 13, 15, 16, 19, 21, 22, 26, 27], "them": [0, 7, 13, 15, 19, 24], "ensur": [0, 14, 15, 18, 19, 21, 22, 24, 26, 27], "ha": [0, 3, 10, 12, 13, 14, 16, 18, 19, 20, 22, 23, 24, 25, 26, 27], "all": [0, 7, 11, 13, 14, 15, 16, 18, 19, 22, 23, 24, 25, 26], "depend": [0, 7, 20, 23, 25, 26, 27, 28], "To": [0, 12, 14, 15, 16, 19, 21, 22, 24, 27], "do": [0, 4, 6, 13, 15, 16, 19, 22, 27], "so": [0, 7, 13, 19, 21, 22, 24, 25], "follow": [0, 6, 10, 11, 13, 15, 16, 19, 21, 22, 24, 25, 26, 27], "step": [0, 15, 16, 20, 22, 25, 26, 27], "instal": [0, 7, 16, 19, 20, 22, 24, 25, 26], "pip": [0, 19, 24, 25], "": [0, 3, 4, 5, 8, 9, 10, 12, 14, 16, 17, 19, 22, 23, 24, 25, 26, 27], "docs_build": 0, "folder": [0, 22, 26], "specifi": [0, 10, 13, 14, 15, 16, 19, 23, 24], "noxfil": 0, "py": [0, 6, 14, 15, 19, 25, 26, 27], "configur": [0, 14, 19, 24, 25, 26, 27], "output": [0, 14, 15, 19], "_build": [0, 14], "html": [0, 3, 5, 14], "live": [0, 10, 14, 26], "updat": [0, 7, 8, 10, 19, 22, 23, 24], "when": [0, 2, 6, 10, 11, 12, 13, 15, 16, 18, 19, 21, 22, 24, 25, 26, 27], "file": [0, 3, 4, 5, 6, 7, 10, 14, 15, 16, 19, 22, 24, 26, 27], "docs_liv": 0, "thi": [1, 2, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 22, 23, 24, 25, 26, 27, 28], "section": [1, 2, 11, 14, 15, 16, 17, 18, 21, 23, 24, 25, 26, 27, 28], "evolv": [1, 7, 21], "publish": [1, 2, 13, 16, 21, 24, 25, 27, 28], "end": [1, 19, 20, 21, 23, 28], "spring": 1, "2023": [1, 28], "common": [2, 5, 12, 13, 22, 24], "python": [2, 3, 13, 23], "ecosystem": [2, 3, 5, 13, 15, 19, 21, 26, 27], "current": [2, 5, 6, 21, 24, 26, 27, 28], "howev": [2, 3, 4, 5, 6, 7, 14, 15, 19, 20, 21, 22, 24, 25, 26, 27], "some": [2, 4, 6, 8, 10, 13, 14, 15, 16, 18, 19, 21, 22, 23, 24, 26, 27], "maintain": [2, 4, 8, 10, 13, 15, 18, 19, 21, 23, 24, 26, 27], "like": [2, 6, 7, 9, 13, 14, 18, 19, 22, 24, 25], "mkdoc": [2, 5], "It": [2, 3, 6, 7, 8, 9, 10, 13, 14, 15, 18, 19, 21, 22, 23, 24, 26, 27], "up": [2, 7, 10, 13, 15, 24, 26, 27], "platform": [2, 11, 25], "prefer": [2, 3, 5, 7, 14, 19, 24, 27], "In": [2, 7, 11, 13, 15, 19, 20, 21, 23, 24, 25, 26, 27, 28], "introduc": [2, 24], "talk": [2, 17], "about": [2, 3, 9, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, 27], "variou": [2, 21, 22, 24], "option": [2, 3, 4, 6, 13, 21, 22, 24, 27], "can": [2, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26], "write": [2, 3, 5, 7, 13, 14, 15, 19, 24, 27], "rst": [2, 5, 14], "also": [2, 4, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "onlin": [2, 11, 12, 13, 22], "might": [2, 3, 7, 8, 13, 15, 16, 17, 19, 21, 22, 26, 27], "help": [2, 6, 7, 10, 13, 15, 16, 18, 19, 20, 21, 24, 27], "optim": 2, "websit": [2, 3, 4, 5, 6, 7, 10, 12, 13, 16, 26], "There": [3, 13, 14, 15, 20, 22, 24, 25, 26, 27], "three": [3, 18, 20, 27], "commonli": [3, 4, 7, 18, 19, 24, 26, 27], "easi": [3, 14, 16, 23, 24, 27], "learn": [3, 18, 19, 22, 25, 26], "default": [3, 14, 19, 22, 24, 26], "jupyt": [3, 26], "notebook": [3, 26], "add": [3, 5, 6, 12, 13, 14, 15, 19, 20, 22, 24, 26, 27], "allow": [3, 4, 6, 10, 14, 15, 18, 19, 20, 21, 22, 23, 24, 27], "render": [3, 14], "limit": [3, 22, 24, 25], "For": [3, 14, 15, 19, 20, 24, 25, 26, 27], "instanc": [3, 15, 19, 20, 24, 27], "refer": [3, 4, 15, 16, 19, 24, 25, 27], "color": 3, "call": [3, 9, 15, 19, 20, 22, 23, 25, 27], "out": [3, 10, 14, 19, 21, 22, 23, 24, 26], "block": [3, 19], "other": [3, 4, 5, 7, 8, 11, 12, 13, 18, 19, 21, 22, 24, 25, 26], "custom": [3, 4, 20, 24], "element": [3, 6, 11, 14, 15, 17], "either": [3, 20, 24], "restructur": 3, "nativ": [3, 5], "support": [3, 4, 5, 6, 7, 14, 15, 16, 18, 20, 21, 22, 23, 25, 26, 27, 28], "wa": [3, 19, 22, 27], "mani": [3, 4, 6, 8, 11, 14, 16, 18, 19, 20, 21, 22, 24, 26, 27], "year": 3, "recent": 3, "risen": 3, "top": [3, 13, 14, 19], "favorit": 3, "given": [3, 16, 26, 27], "flexibl": [3, 18, 21, 24], "combin": [3, 14], "vanilla": 3, "nice": [3, 10, 14], "becaus": [3, 15, 18, 19, 22, 24, 25, 27], "offer": [3, 4, 6, 24], "both": [3, 7, 11, 13, 14, 15, 16, 19, 21, 24, 25, 26, 27], "rich": 3, "function": [3, 5, 14, 16, 17, 18, 19, 20, 24, 25, 26, 27], "simpl": [3, 7, 13, 15, 16, 20, 21, 22, 23, 24, 26], "while": [3, 5, 6, 10, 19, 22, 23, 24, 25, 26, 27], "chose": [3, 6, 15, 19, 20], "ani": [3, 9, 10, 12, 16, 18, 19, 22, 24, 25, 27], "list": [3, 6, 7, 12, 13, 14, 15, 16, 18, 19, 24], "abov": [3, 10, 11, 13, 15, 16, 19, 24, 26, 27], "suggest": [3, 4, 7, 15, 19, 20, 26, 27], "simpler": [3, 20, 27], "thu": [3, 12, 13, 15, 22, 24, 25, 26, 27], "easier": [3, 5, 14, 15, 17, 18, 22, 24], "simplic": 3, "make": [3, 6, 10, 14, 15, 16, 17, 18, 22, 24, 25, 26, 27], "more": [3, 4, 6, 7, 13, 15, 16, 18, 19, 20, 21, 25, 26, 27], "peopl": [3, 6, 7, 8, 16, 18, 22, 26, 27], "contribut": [3, 7, 8, 10, 15, 16, 18, 19, 25, 26], "core": [3, 6, 15, 18, 19, 21, 22, 24, 25], "packag": [3, 6, 12], "readm": [3, 7, 9, 11, 16, 23, 24, 25, 26], "md": [3, 7, 10, 14, 16, 23, 25, 26], "alreadi": [3, 24, 25, 26], "format": [3, 4, 10, 14, 21, 23, 25, 27], "github": [3, 7, 11, 12, 13, 14, 16, 18, 19, 20, 22, 23, 27], "wide": [3, 15, 27], "scientif": [3, 5, 13, 15, 18, 19, 21, 22, 24, 27], "fenc": 3, "setup": [4, 10, 14, 19, 20, 21, 24, 25], "host": [4, 7, 26], "servic": 4, "two": [4, 14, 15, 16, 22, 23, 25, 26], "below": [4, 7, 11, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 26, 27], "yourself": [4, 8, 26], "anoth": [4, 11, 13, 14, 15, 20, 22, 24], "project": [4, 12, 13, 16, 23, 24, 25, 27], "fulli": [4, 24, 27], "featur": [4, 10, 16, 20, 21, 26, 27], "its": [4, 7, 15, 16, 24, 25], "paid": 4, "tier": 4, "autom": [4, 27], "build": [4, 7, 10, 13, 15, 18, 21, 22, 25, 26, 28], "turn": [4, 20, 27], "integr": [4, 10, 18, 22, 25], "where": [4, 14, 16, 19, 23, 24, 27], "view": [4, 5, 7, 15, 18, 23, 24], "progress": [4, 18], "success": 4, "failur": 4, "version": [4, 15, 18, 19, 22, 23, 24, 25, 26], "which": [4, 5, 8, 13, 15, 18, 19, 22, 24, 26, 27], "user": [4, 5, 8, 9, 10, 12, 13, 14, 15, 18, 24, 25, 26, 27], "older": [4, 24], "tag": [4, 6, 23, 24], "thei": [4, 6, 7, 8, 10, 13, 14, 16, 19, 21, 22, 24, 26, 27], "download": [4, 14], "pdf": 4, "readthedoc": 4, "yaml": [4, 19], "web": [4, 6, 24], "local": [4, 10, 22, 24, 26, 27], "continu": [4, 10, 18, 22], "push": [4, 22, 27], "branch": 4, "great": [4, 13, 15, 21, 24], "deploy": 4, "bit": 4, "deploi": 4, "account": 4, "entir": [4, 6, 19], "process": [4, 10, 15, 18, 19, 22], "don": [4, 7, 13, 15, 19, 24], "t": [4, 7, 13, 15, 18, 19, 22, 24, 25, 27], "On": [5, 14, 22], "discuss": [5, 7, 10, 12, 15, 16, 18, 19, 20, 22, 24, 25, 26, 27], "your": [5, 18, 20, 21, 24, 25, 28], "face": [5, 7, 15, 18, 26], "explor": [5, 14, 21], "gain": 5, "popular": [5, 6, 12, 24], "exampl": [5, 7, 11, 12, 13, 14, 16, 22, 25], "love": [5, 18], "geopanda": [5, 15, 16], "land": [5, 13, 14], "verd": [5, 9, 15], "code": [5, 7, 9, 10, 11, 12, 14, 16, 17, 18, 20, 21, 24, 25, 26, 27], "our": [5, 7, 18, 20, 21, 23, 24, 26], "A": [5, 7, 9, 10, 14, 15, 16, 18, 19, 21, 24, 25, 27], "base": [5, 6, 7, 10, 14, 15, 19, 21, 24], "upon": [5, 21, 24, 26, 27], "set": [5, 6, 7, 10, 14, 18, 24, 25, 26, 27], "templat": 5, "serv": [5, 13, 24], "mean": [5, 15, 24, 25, 26, 27], "modif": 5, "fly": 5, "written": [5, 16, 20, 21, 22, 23, 24], "extend": [5, 19], "few": [5, 13, 19, 20, 21, 24, 25, 26], "appli": [5, 12, 13, 15, 19, 27], "quick": [5, 13, 16, 24], "beauti": 5, "automat": [5, 12, 18, 19, 27], "class": [5, 14, 15, 16, 17], "api": [5, 14, 16, 17, 23, 27], "from": [5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 22, 24, 25, 26, 27], "docstr": [5, 10, 16, 19], "autodoc": [5, 15, 17], "test": [5, 7, 10, 14, 15, 18, 22, 24, 25, 27], "doctest": 5, "parser": 5, "whatev": [5, 25], "pydata": [5, 6], "book": [5, 6], "furo": 5, "interest": [6, 9, 19], "mai": [6, 8, 10, 14, 15, 16, 19, 21, 22, 23, 24, 25, 26, 27], "extens": [6, 14, 15, 17, 18, 21, 25, 27], "compliant": 6, "european": 6, "gener": [6, 15, 16, 20, 22, 24, 25, 27], "data": [6, 7, 14, 15, 22, 24], "protect": [6, 8], "regul": 6, "gdpr": 6, "compon": [6, 20], "one": [6, 9, 15, 19, 21, 24, 27], "let": [6, 13, 16, 19], "know": [6, 7, 13, 15, 24, 27], "site": [6, 13, 20], "collect": [6, 13, 19], "consent": 6, "possibl": [6, 16], "infrastructur": [6, 7, 18, 19], "around": [6, 8, 13, 18, 19, 21, 27], "close": [6, 18, 19, 27], "slowli": 6, "shift": 6, "awai": [6, 19], "open": [6, 12, 19, 20, 21, 22, 24, 26], "plausibl": 6, "cloudflar": 6, "matomo": 6, "pyopensci": [6, 10, 12, 13, 19, 22, 23, 27], "look": [6, 11, 14, 18, 19, 21, 24, 25], "sourc": [6, 12, 19, 21, 22, 27], "develop": [6, 7, 9, 12, 13, 15, 16, 19, 21, 22, 23, 24, 26, 27, 28], "doe": [6, 14, 19, 24, 25, 27], "sphinxcontrib": 6, "gtagj": 6, "try": [6, 13, 21, 22], "move": [6, 11, 13, 18, 24, 26], "complianc": 6, "privaci": 6, "still": [6, 7, 24, 27], "import": [6, 7, 8, 13, 15, 19, 24, 25, 27], "And": [6, 14, 15, 19, 22, 24], "xml": 6, "index": [6, 14, 26], "over": [6, 13, 24, 26], "time": [6, 10, 13, 14, 15, 19, 20, 22, 24, 26, 27], "visibl": 6, "lightweight": 6, "requir": [6, 7, 10, 12, 15, 18, 19, 20, 22, 23, 24, 25, 27], "conf": [6, 14, 15], "url": 6, "metadata": [6, 24, 25, 26, 27], "protocol": [6, 21], "provid": [6, 13, 14, 15, 16, 19, 20, 21, 22, 23, 24, 27], "preview": 6, "share": [6, 12, 18, 21], "social": 6, "media": 6, "twitter": 6, "mastodon": 6, "even": [6, 15, 19, 24, 27], "slack": 6, "discours": [6, 20], "note": [7, 16, 20, 24, 25, 26, 27], "those": [7, 14, 15, 16, 19, 21, 22, 24, 26, 27], "As": [7, 15, 20, 24, 25, 26, 27], "guid": [7, 9, 11, 12, 15, 16, 20, 23, 24, 26, 27], "peer": [7, 18, 19, 21, 27], "focus": [7, 14, 19, 20, 22], "toctre": 7, "hidden": [7, 27], "best": [7, 17, 18, 19, 21, 22, 24, 26], "practic": [7, 17, 18, 21, 27], "doc": [7, 13, 15, 24, 26], "licens": [7, 9, 11, 13, 18, 23, 25, 26], "itself": [7, 8, 13, 19, 21], "qualiti": [7, 13, 15], "cours": 7, "valuabl": [7, 10, 19], "how": [7, 8, 9, 10, 11, 12, 16, 17, 23, 24, 27], "get": [7, 12, 13, 14, 15, 16, 18, 19, 21, 22, 24, 26], "task": [7, 15, 24], "done": [7, 19, 20], "understand": [7, 15, 18, 19, 24, 26, 27], "workflow": [7, 10, 15, 16, 18, 20, 21, 25, 26, 27, 28], "won": [7, 19, 24, 26], "further": [7, 15, 20], "explicitli": [7, 24], "target": 7, "who": [7, 16, 17, 21, 22, 26], "new": [7, 10, 14, 15, 18, 19, 21, 22, 24, 26], "er": 7, "scienc": [7, 10], "expert": [7, 16, 18], "programm": [7, 15, 16], "But": [7, 24, 27], "background": [7, 13], "softwar": [7, 12, 18], "These": [7, 8, 14, 18, 19, 20, 21, 22, 24, 25, 26, 27], "start": [7, 13, 14, 15, 16, 18, 19, 21, 24, 26], "inform": [7, 9, 10, 18, 23, 26], "cite": [7, 13], "give": [7, 19], "credit": 7, "research": 7, "applic": [7, 13], "oper": [7, 14, 15, 19, 23, 24, 25, 27], "subset": 7, "experienc": 7, "engag": [7, 8], "abl": [7, 27], "bug": [7, 8, 22, 27], "fix": [7, 8, 19, 24, 27], "just": [7, 10, 20, 21, 24, 26], "spell": 7, "error": [7, 18, 19, 27], "tutori": [7, 15, 16, 17, 23, 26], "thing": [7, 9, 10, 18, 19, 24], "d": [7, 9, 13, 18, 19, 24], "guidelin": [7, 9, 10, 18, 19, 27], "clarifi": 7, "rememb": [7, 19], "definit": [7, 15, 19], "broad": [7, 16, 22], "could": [7, 19, 20, 24, 25, 27], "report": 7, "cover": [7, 10, 14, 17, 18, 23, 28], "edg": 7, "case": [7, 10, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "discov": [7, 19, 24], "structur": [7, 14, 15, 18, 19, 23, 24], "specif": [7, 10, 15, 19, 20, 21, 22, 24, 25, 27], "found": [7, 9, 16, 19, 22, 23, 24, 26, 27], "check": [7, 14, 15, 21, 22, 24, 26, 27], "link": [7, 9, 10, 11, 14, 16, 27], "consid": [7, 8, 10, 12, 13, 15, 16, 17, 18, 21, 22, 24, 26, 27], "detail": [7, 16, 18, 19, 22, 24, 26, 27], "movingpanda": [7, 11, 13, 22], "major": [7, 18, 24, 27], "code_of_conduct": [7, 25, 26], "txt": [7, 12, 25, 26], "screen": [7, 11, 13], "shot": [7, 11, 13], "taken": [7, 11, 13], "nov": [7, 11, 13], "23": [7, 11, 13], "2022": [7, 11, 13], "walk": [7, 17], "through": [7, 12, 13, 17, 18, 24], "scipi": [8, 12, 21, 26], "notic": [8, 11, 14, 15, 16, 19, 23, 26], "theirs": 8, "document": [8, 10, 12, 18, 21, 24, 26, 27], "fatiando": [8, 9], "locat": [8, 9, 13, 19, 26, 27], "root": [8, 9, 12, 13, 19, 26], "onc": [8, 13, 19, 22], "question": [8, 9, 16, 20, 22, 24], "encount": [8, 22, 26], "challeng": 8, "team": [8, 19, 22, 24, 27], "order": [8, 10, 15, 19], "keep": [8, 11, 15, 16, 18, 22, 24, 27], "healthi": 8, "mainatian": 8, "unhealthi": 8, "behavior": [8, 24], "establish": 8, "what": [8, 12, 14, 16, 19, 24, 25, 27], "expect": [8, 15], "term": [8, 12, 13, 16, 24], "contributor": [8, 10, 13, 14, 15, 18, 19, 23, 24, 27], "interact": [8, 24], "rule": [8, 18, 19], "enforc": [8, 19, 27], "harm": 8, "neg": 8, "own": [8, 24], "encourag": [8, 18, 22, 24], "adopt": [8, 21, 24, 27], "languag": [8, 13, 16, 18, 21, 22, 23, 24, 25, 26, 27], "coven": 8, "terra": 8, "geoscienc": 8, "pygmt": 9, "type": [9, 10, 14, 16, 17, 19, 20, 22, 24, 27], "happen": [9, 27], "someon": [9, 13, 14, 16, 23, 26], "ask": [9, 13, 16, 24], "place": [9, 18, 24, 26], "conduct": [9, 11], "ideal": [10, 13, 14, 16, 22, 24], "clearli": [10, 13], "show": [10, 11, 13, 14, 15, 21, 24], "technic": [10, 13, 16], "profici": 10, "suit": [10, 13, 14, 15, 18, 19, 22], "standard": [10, 19, 21, 22, 23, 24, 27], "style": [10, 18, 21], "approach": [10, 21, 24, 26, 27], "exist": [10, 18, 21, 22, 26, 27], "releas": [10, 24, 25], "onboard": 10, "inclin": 10, "thought": [10, 27], "mainten": [10, 13, 14, 18, 26, 27], "futur": [10, 15, 20, 23, 24, 27], "well": [10, 11, 13, 14, 15, 16, 18, 21, 24, 27], "skip": 10, "especi": [10, 15, 24, 26], "strongli": [10, 24, 26], "recommend": [10, 18, 24, 26, 27], "elig": 10, "review": [10, 11, 12, 13, 14, 18, 19, 22, 27], "opt": 10, "mozilla": 10, "lab": 10, "outlin": 10, "minimum": [11, 18, 21], "mention": [11, 13, 24], "etc": [11, 19, 23], "measur": [11, 13], "health": [11, 13], "evalu": [11, 13], "avail": [11, 13, 19, 21, 22, 27], "among": 11, "level": [11, 13, 14, 15, 16, 20, 26, 27], "repo": [11, 16, 19, 20, 24, 27], "snyk": [11, 13], "known": [11, 22], "compani": 11, "tab": [11, 24], "similar": [11, 13, 15, 19, 24, 25], "screenshot": 11, "panda": [11, 13, 26], "approv": [12, 18, 22, 23], "initi": [12, 15, 19], "osi": [12, 18, 23], "handi": 12, "choos": 12, "copi": 12, "everi": [12, 15, 19, 22], "differ": [12, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27], "borrow": 12, "compli": 12, "select": [12, 18, 20, 21, 24], "would": [12, 19, 26, 27], "bsd": [12, 23], "mit": 12, "stackoverflow": 12, "stack": 12, "overflow": 12, "creativ": 12, "alik": 12, "sharealik": 12, "same": [12, 19, 22, 23, 24, 25, 26, 27], "reus": 12, "violat": 12, "proce": 12, "caution": [12, 24], "excel": [12, 20, 24, 27], "worth": [12, 26], "read": [12, 13, 15, 16, 17, 19, 23, 24, 25, 26], "often": [13, 15, 19, 20, 21, 24, 25, 26, 27], "befor": [13, 15, 19, 21, 26], "appear": 13, "pypi": [13, 24, 25, 26, 27, 28], "anaconda": [13, 26, 28], "highlight": [13, 24], "pandera": 13, "spend": [13, 24], "front": [13, 20, 21, 26, 27, 28], "high": [13, 15, 16, 20], "editor": [13, 19, 21], "chief": 13, "revis": 13, "begin": [13, 14, 19, 21, 24], "meet": [13, 18, 21], "criteria": [13, 18], "go": [13, 18, 24], "checklist": 13, "explan": [13, 15, 18], "2": [13, 14, 15, 23, 24, 25], "4": [13, 15, 16, 19], "sentenc": [13, 15, 19], "context": [13, 15], "fit": [13, 21], "broader": [13, 16, 18, 24], "librari": [13, 16, 19], "wrap": [13, 19, 21, 24], "associ": [13, 18, 24, 27], "hint": 13, "wrapper": 13, "probabl": 13, "doesn": [13, 18, 19, 22, 24, 25], "ve": [13, 18, 24], "bottom": [13, 14], "self": [13, 15, 27], "explanatori": 13, "better": [13, 18, 24, 27], "draw": 13, "attent": 13, "assur": [13, 15], "design": [13, 15], "properli": [13, 15], "ad": [13, 14, 16, 17, 19, 22, 23, 24, 26], "statu": 13, "fail": [13, 26], "toward": [13, 18], "brows": 13, "cloud": [13, 26, 28], "pass": [13, 15, 19], "doi": 13, "accept": [13, 21], "been": [13, 18, 19, 24, 25, 26, 27], "bewar": [13, 24], "overus": 13, "overload": 13, "potenti": [13, 14, 19, 24, 26, 27], "At": 13, "1": [13, 14, 15, 19, 23, 24, 25], "3": [13, 15, 18, 19, 23, 24, 25, 26], "state": [13, 16, 24], "goal": [13, 16, 21], "varieti": 13, "vari": 13, "complementari": 13, "school": [13, 16], "equival": [13, 27], "appropri": 13, "maxim": 13, "access": [13, 16, 22, 25, 26, 27], "sure": [13, 15, 19, 26], "authent": 13, "token": 13, "complex": [13, 15, 21, 24, 25, 26], "rather": [13, 14, 16, 19, 24, 26, 27], "than": [13, 14, 19, 20, 24, 26], "complic": 13, "avoid": [13, 19, 22], "sever": [13, 15, 16, 22, 24], "overwhelm": 13, "plenti": 13, "present": [13, 14, 26], "direct": [13, 16], "advanc": [13, 24], "final": [13, 22, 24, 27], "bane": 13, "sullivan": 13, "art": 13, "kira": 13, "hackergrrl": 13, "finish": 14, "second": [14, 24], "reproduc": 14, "construct": 14, "act": 14, "via": [14, 24, 27], "thumbnail": 14, "plot": 14, "script": [14, 15], "enjoi": 14, "mimic": 14, "method": [14, 16, 17], "attribut": [14, 15, 16, 17, 25, 27], "ie": [14, 15, 24], "ipynb": 14, "friendli": [14, 24], "visual": 14, "grid": 14, "execut": 14, "per": 14, "downsid": 14, "finicki": 14, "particularli": [14, 24, 25, 26], "matplotlib": 14, "name": [14, 16, 19, 22, 23, 24, 25, 26, 27], "plot_": 14, "dai": [14, 27], "slightli": [14, 15, 24, 26], "nuanc": [14, 20, 24], "successfulli": [14, 19], "directori": [14, 19, 22, 24, 25, 26], "plot_tutori": 14, "produc": 14, "build_exampl": 14, "plot_sampl": 14, "built_exampl": 14, "dir": 14, "sg_execution_tim": 14, "similarli": [14, 22, 27], "pro": 14, "con": 14, "By": [14, 15, 24, 26], "addit": [14, 15, 16, 18, 19, 20, 21, 24, 25, 27], "epilog": 14, "singl": [14, 15, 24, 27], "column": 14, "another_tutori": 14, "separ": [14, 15, 23, 24], "seri": 14, "onpythonpackag": 14, "stand": 15, "ppli": 15, "p": 15, "rogram": 15, "nterfac": 15, "add_numb": 15, "bunch": 15, "number": [15, 24, 25], "simpli": 15, "calcul": 15, "valu": [15, 23, 27], "return": [15, 19, 24, 27], "6": [15, 18, 19], "consist": [15, 19, 21, 22, 24, 25, 27], "interfac": [15, 24], "describ": [15, 16, 21, 27], "input": 15, "usual": [15, 22], "paramet": 15, "argument": [15, 24], "effect": 15, "automag": [15, 17, 19, 27], "full": [15, 18, 22, 24], "clean": [15, 18, 19, 22, 24], "along": 15, "brief": 15, "dig": 15, "down": [15, 24, 26], "click": [15, 23, 24, 26], "descript": [15, 23, 27], "reason": [15, 21, 25, 26, 27], "explain": [15, 27], "defin": [15, 16, 25], "string": [15, 19], "int": 15, "np": 15, "arrai": 15, "object": 15, "googl": 15, "rest": 15, "simplifi": [15, 27], "contrast": 15, "harder": [15, 26, 27], "scan": [15, 19], "take": [15, 19, 26], "line": [15, 19, 24, 27], "modul": [15, 19], "napoleon": 15, "good": [15, 18, 21, 27], "short": [15, 16], "longer": [15, 19, 24], "def": 15, "extent_to_json": 15, "ext_obj": 15, "convert": 15, "bound": [15, 24], "shape": [15, 18], "geojson": 15, "spatial": [15, 16], "crop": 15, "raster": 15, "imag": [15, 19], "geodatafram": 15, "extent": [15, 27], "otherwis": [15, 27], "minx": 15, "mini": 15, "maxx": 15, "maxi": 15, "extent_json": 15, "dictionari": 15, "corner": 15, "coordin": [15, 19], "repres": [15, 24], "contain": [15, 18, 22, 23, 25, 26, 27], "gpd": 15, "earthpi": 15, "e": [15, 18, 19, 20, 24, 26], "io": 15, "path_to_exampl": 15, "load": 15, "shapefil": 15, "rmnp": 15, "read_fil": 15, "shp": 15, "convers": [15, 27], "polygon": 15, "105": 15, "4935937": 15, "40": 15, "1580827": 15, "correct": [15, 20, 24], "mind": [15, 16, 24], "neither": [15, 19], "item": [15, 19, 25], "replac": [15, 23], "alon": [15, 21], "across": [15, 18, 19, 21, 22, 24, 25, 26], "system": [15, 23, 24, 25, 26, 27], "add_m": 15, "num1": 15, "num2": 15, "sum": 15, "integ": 15, "saw": [15, 19], "layer": [15, 21, 24], "anum": 15, "anum2": 15, "being": [15, 18, 21, 24], "debug": 15, "faster": [15, 25], "static": 15, "mypi": 15, "perform": [15, 21, 24], "lower": 15, "entranc": 15, "barrier": 15, "difficult": [15, 18, 20, 24], "true": 15, "multipl": [15, 19, 24, 27], "obviou": [15, 23], "sens": [15, 27], "lot": [15, 24], "increment": 15, "break": [16, 24, 27], "broadli": [16, 19, 22], "granular": 16, "showcas": 16, "greater": 16, "navig": [16, 24], "highli": 16, "audienc": 16, "whenev": 16, "jargon": 16, "instruct": 16, "reader": 16, "vignett": 16, "small": [16, 19, 26, 27], "involv": [16, 27], "part": [16, 19, 26], "store": [16, 23, 24, 25, 27], "card": 16, "popul": 17, "galleri": 17, "curat": 18, "surround": [18, 19, 24], "decis": [18, 19, 20, 27], "vision": 18, "landscap": 18, "conda": [18, 19, 24, 25], "forg": [18, 19], "author": [18, 19, 21, 23], "expertis": 18, "usabl": 18, "relat": [18, 19, 22], "knowledg": [18, 24], "area": 18, "foundat": 18, "modern": [18, 21, 24, 27], "effici": 18, "assum": [18, 27], "guidanc": [18, 21], "friend": [18, 19], "come": [18, 24, 26], "right": [18, 22], "incredibli": 18, "numer": [18, 24, 26], "domain": [18, 24], "xkcd": 18, "comic": 18, "enough": [18, 24], "bar": 18, "higher": 18, "hope": 18, "ultim": 18, "beyond": [18, 19], "now": [18, 22, 27], "invit": 18, "mayb": 18, "ci": [18, 22, 27], "too": [18, 19], "cooki": 18, "cutter": 18, "situat": 18, "yet": 18, "soon": 18, "must": 18, "alwai": [18, 19, 26, 27], "explicit": 18, "compat": [18, 24, 27], "old": 18, "thumb": 18, "least": 18, "latest": 18, "g": [18, 19, 20, 24, 26], "8": [18, 19, 24, 27], "7": 18, "consult": 18, "pep": [18, 19, 21, 24, 27], "http": [18, 19], "www": 18, "org": [18, 22, 23], "dev": [18, 19], "0008": 18, "lint": 18, "linter": 18, "flake8": 18, "readabl": [19, 23], "precommit": 19, "bot": [19, 27], "pr": 19, "config": 19, "save": 19, "signific": [19, 26], "without": [19, 24, 25], "space": [19, 26], "punctuat": 19, "brain": 19, "forinstanceifyousawasentencelikethisonewithoutani": 19, "benefit": [19, 24], "daili": 19, "manual": [19, 24], "consum": 19, "road": 19, "reformat": 19, "adher": [19, 24], "throughout": [19, 27], "inconsist": 19, "lengthi": 19, "person": 19, "dure": 19, "implement": [19, 21, 27], "dive": 19, "identifi": [19, 23, 24], "typic": 19, "tell": [19, 24], "stylist": 19, "doubl": 19, "quot": 19, "unapologet": 19, "except": [19, 25], "length": 19, "88": 19, "79": 19, "10": 19, "charact": 19, "overwritten": 19, "adjust": [19, 26], "comment": 19, "address": [19, 24], "compar": [19, 24], "decid": [19, 22, 24], "playground": 19, "leav": [19, 24], "worri": [19, 25], "pep8": 19, "toolbox": 19, "flag": 19, "conflict": 19, "miss": [19, 24, 26], "after": [19, 27], "comma": 19, "unus": 19, "declar": 19, "variabl": [19, 27], "filenam": [19, 25], "stravalib": [19, 25], "model": 19, "usernam": 19, "comput": [19, 25], "f401": 19, "o": [19, 23], "29": 19, "80": 19, "e501": 19, "long": [19, 24, 27], "90": 19, "34": 19, "95": 19, "442": 19, "82": 19, "443": 19, "39": 19, "e231": 19, "whitespac": 19, "493": 19, "20": 19, "e225": 19, "496": 19, "group": [19, 24, 26, 27], "third": 19, "parti": 19, "reorder": 19, "think": [19, 21, 26], "exc": 19, "starvalib": 19, "abc": 19, "log": 19, "distribut": [19, 20, 22, 24], "extra": 19, "sequenc": 19, "unithelp": 19, "uh": 19, "shown": 19, "vscode": [19, 24], "pycharm": [19, 24], "shortcut": 19, "demand": 19, "action": [19, 27], "trigger": [19, 27], "m": [19, 24, 27], "messag": [19, 24, 27], "hit": 19, "NOT": [19, 24, 26], "re": [19, 21], "stage": [19, 22], "next": [19, 24], "record": [19, 25], "cancel": 19, "activ": [19, 24, 26, 27], "intend": 19, "amount": 19, "lead": [19, 22, 25], "merg": [19, 22], "trail": 19, "streamlin": [19, 24], "becom": [19, 27], "comer": 19, "never": [19, 24, 27], "c": [19, 20, 21, 22], "cofig": 19, "com": 19, "pycqa": 19, "rev": 19, "5": 19, "11": [19, 26], "id": [19, 24], "misc": 19, "v4": 19, "0": [19, 23, 24, 25, 27], "ref": 19, "autoformat": 19, "newlin": 19, "onli": [19, 20, 22, 24, 27], "fixer": 19, "insensit": 19, "filesystem": 19, "maco": 19, "hf": 19, "window": [19, 22, 25], "fat": 19, "auto": [19, 24], "psf": 19, "22": 19, "12": 19, "language_vers": 19, "python3": [19, 24], "codo": 19, "quarter": 19, "weekli": 19, "remov": [19, 24], "aren": [19, 26], "autoupdate_schedul": 19, "quarterli": 19, "readi": [19, 25], "regardless": [19, 22], "whether": [19, 26], "manag": [19, 23, 24, 25, 28], "feedback": [19, 24], "reduc": [19, 24], "effort": [19, 21, 26], "compil": [20, 24, 25, 26], "non": 20, "overview": [20, 21, 24, 26, 27], "thorough": 20, "classifi": [20, 23], "categori": 20, "back": [20, 23], "reli": [20, 24, 27], "setuptool": 20, "hatch": [20, 23], "hatchl": [20, 24], "pdm": 20, "choic": [20, 24, 27], "fortran": [20, 24], "gdal": [20, 22], "scikit": [20, 24, 26], "meson": [20, 24], "confus": [21, 24], "diagram": [21, 24], "bare": 21, "plan": [21, 24], "u": 21, "anyon": [21, 22, 25], "expand": 21, "pure": [21, 25, 27], "align": [21, 24], "enhanc": 21, "spec": 21, "numpi": [21, 26], "program": [21, 23, 24], "lend": 21, "divers": 21, "rang": [21, 24], "abil": 21, "hear": 21, "glue": 21, "newer": [21, 24], "layout": 21, "made": [21, 27], "intent": 21, "scope": 21, "public": 22, "bioconda": 22, "minim": [22, 23], "between": [22, 24], "prior": 22, "biggest": 22, "wherea": 22, "sdist": [22, 23, 24], "tar": [22, 25], "gz": [22, 25], "zip": [22, 25], "wheel": [22, 23, 24], "whl": [22, 24], "realli": 22, "bundl": [22, 25], "privat": 22, "origin": 22, "cross": 22, "julia": 22, "r": [22, 24], "mix": 22, "fledg": 22, "bla": 22, "lapack": 22, "hous": 22, "inc": 22, "driven": 22, "geospati": 22, "biomed": 22, "emerg": 22, "did": 22, "geohackweek": 22, "wonder": 22, "why": 22, "importantli": 22, "pick": [22, 24], "answer": 22, "everyth": [22, 25], "speak": 22, "smaller": [22, 24, 26], "chanc": 22, "yield": 22, "stabl": 22, "complement": 22, "anticip": 22, "terminologi": 22, "glossari": 22, "straight": 22, "forward": 22, "recip": 22, "grayskul": 22, "mac": [22, 25], "linux": [22, 25], "iron": 22, "feedstock": 22, "kick": 22, "off": 22, "complet": [22, 24], "notif": 22, "happi": 22, "cfg": [23, 25], "tom": 23, "kei": [23, 27], "pair": 23, "tabl": 23, "particular": 23, "human": [23, 27], "caus": 23, "problem": 23, "backend": [23, 24, 27], "examplepi": 23, "email": 23, "keyword": [23, 27], "independ": 23, "swap": 23, "setuptools_scm": [23, 24, 25], "control": [23, 24], "61": 23, "build_meta": 23, "poetri": 23, "focu": 24, "draft": 24, "truli": 24, "until": 24, "were": 24, "pypa": [24, 26], "survei": 24, "twine": 24, "beginn": [24, 26], "oppos": 24, "upper": 24, "overrid": 24, "discord": 24, "lock": 24, "matrix": 24, "clear": [24, 26], "winner": 24, "mode": 24, "stick": 24, "experi": 24, "upload": [24, 26], "testpypi": 24, "dist": [24, 25], "main": [24, 27], "much": 24, "plugin": [24, 27], "undocu": 24, "correctli": [24, 26], "result": 24, "n": 24, "000": [24, 26], "seen": [24, 26], "heavili": 24, "snapshot": 24, "ye": 24, "hook": [24, 27], "appreci": [24, 26], "summar": 24, "git": [24, 25], "bump": 24, "bu": 24, "factor": 24, "semant": [24, 26], "commit": [24, 27], "receiv": 24, "pyd": 24, "app": 24, "critic": 24, "virtual": 24, "__pypackages__": 24, "No": 24, "init": 24, "dynam": 24, "patch": [24, 27], "minor": [24, 27], "pyproject": [24, 25, 26], "toml": [24, 25, 26], "edit": 24, "strict": 24, "constraint": 24, "came": 24, "Its": 24, "individu": 24, "risk": 24, "gap": 24, "frill": 24, "basic": 24, "symlink": 24, "track": [24, 27], "handl": 24, "instead": 24, "unifi": 24, "makefil": [24, 25], "drop": 24, "switch": 24, "hatch_vc": [24, 25], "creation": 24, "uniqu": 24, "tox": 24, "easili": 24, "burden": [24, 26], "lack": 24, "desir": 24, "recogn": 24, "upcom": 24, "organ": 24, "problemat": 24, "quit": 24, "symbol": 24, "breakout": 24, "9": [24, 27], "x": [24, 25, 27], "calver": [24, 27], "date": [24, 27], "matur": 24, "2009": 24, "earlier": 24, "largest": 24, "accord": 24, "customiz": 24, "backward": [24, 27], "compatibli": 24, "pylanc": 24, "comparison": 24, "awar": 24, "exclud": 24, "manifest": [24, 25], "raw": 25, "onto": 25, "veri": [25, 27], "unbuilt": 25, "ourc": 25, "ribut": 25, "impli": [25, 27], "compress": 25, "network": 25, "normal": [25, 26, 27], "tarbal": 25, "post2": 25, "__init__": [25, 26], "conftest": 25, "strava_api_stub": 25, "test_client": 25, "unit": 25, "test_attribut": 25, "auth_respond": 25, "ini": 25, "util": 25, "_version": [25, 27], "_version_gener": 25, "egg": 25, "info": 25, "pkg": 25, "dependency_link": 25, "top_level": 25, "changelog": [25, 26], "yml": 25, "whose": 25, "binari": 25, "machin": 25, "pre": [25, 27], "malici": 25, "inject": 25, "py3": 25, "none": 25, "post": 25, "processor": 25, "architectur": 25, "unpack": 25, "unzip": 25, "client": 25, "advantag": 26, "tremend": 26, "proof": 26, "mypackagereponam": 26, "mypackag": 26, "modulea": 26, "moduleb": 26, "chapter": 26, "sourmash": 26, "bokeh": 26, "openscm": 26, "awkward": 26, "poliastro": 26, "against": 26, "outsid": 26, "size": 26, "storag": 26, "400": 26, "search": 26, "path": 26, "forc": 26, "prioriti": 26, "pythonsafepath": 26, "Be": 26, "pytest": 26, "accompani": 26, "larg": 26, "slow": 26, "discourag": 26, "figshar": 26, "zenodo": 26, "pooch": 26, "increas": [26, 27], "toll": 26, "deal": 26, "thousand": 26, "tend": 26, "respect": 26, "had": 26, "cost": 26, "primari": [26, 27], "characterist": 26, "file1": 26, "histor": 26, "unlik": 26, "engrain": 26, "danger": 26, "xarrai": 26, "invest": 26, "takewai": 27, "equat": 27, "hatch_vsc": 27, "flit": 27, "hand": 27, "440": 27, "assign": 27, "Being": 27, "express": 27, "deprec": 27, "polici": 27, "incompat": 27, "manner": 27, "label": 27, "One": 27, "bump2vers": 27, "determin": 27, "ex": 27, "With": 27, "truth": 27, "elimin": 27, "vc": 27, "anywher": 27, "sometim": 27, "hard": 27, "enter": 27, "Not": 27, "slower": 27, "convent": 27, "word": 27, "attribute_warn": 27, "mod_plot": 27, "warn": 27, "athlet": 27, "feat": 27, "add_convers": 27, "hasn": 27, "sinc": 27, "2020": 27, "troubleshoot": 27, "cleaner": 27, "histori": 27, "wrong": 27, "stai": 28, "tune": 28, "under": 28, "januari": 28}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"contribut": [0, 9, 13], "guid": [0, 10, 13, 18, 21], "python": [0, 4, 5, 7, 8, 9, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 27, 28], "open": [0, 7, 8, 9, 16, 18], "sourc": [0, 7, 8, 9, 16, 18, 25, 26], "softwar": 0, "packag": [0, 4, 5, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28], "book": 0, "how": [0, 4, 13, 15, 18, 19, 22, 26], "thi": [0, 7, 18, 21], "structur": [0, 21, 26], "instruct": [0, 13], "build": [0, 2, 5, 14, 20, 23, 24, 27], "document": [0, 2, 3, 4, 5, 6, 7, 11, 13, 14, 15, 16, 17], "local": [0, 19], "your": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 22, 23, 26, 27], "comput": 0, "ci": [1, 19], "test": [1, 13, 26], "come": [1, 28], "soon": [1, 28], "tool": [2, 7, 19, 24, 27, 28], "host": 2, "syntax": 3, "markdown": 3, "v": [3, 4, 19, 20, 24, 25, 27], "myst": 3, "rst": 3, "creat": [3, 14, 16, 18, 27], "doc": [3, 4, 14], "publish": [4, 22], "onlin": 4, "what": [4, 7, 9, 10, 13, 15, 18, 21, 22, 26], "i": [4, 7, 10, 15, 18, 22, 23], "read": 4, "github": [4, 25], "page": [4, 16], "us": [5, 13, 14, 15, 19, 23, 24, 26, 27], "sphinx": [5, 6, 14], "static": 5, "site": 5, "gener": [5, 19], "can": [5, 22, 24, 27], "custom": 5, "extens": [5, 20, 24], "theme": 5, "commonli": 5, "optim": 6, "so": 6, "search": 6, "engin": 6, "other": [6, 20, 27], "user": [6, 7, 16, 17, 22], "find": [6, 18], "googl": 6, "analyt": 6, "sitemap": 6, "sphinxext": 6, "opengraph": 6, "critic": 7, "": [7, 13, 15, 18, 21], "success": 7, "two": 7, "type": [7, 15], "1": [7, 27], "basic": 7, "2": [7, 27], "potenti": 7, "contributor": 7, "element": [7, 16], "pyopensci": [7, 18, 21, 26], "look": [7, 26], "review": [7, 21, 24, 26], "next": 7, "section": [7, 13], "The": [8, 25, 26], "code_of_conduct": 8, "md": [8, 9, 12, 13], "file": [8, 9, 11, 12, 13, 23, 25], "In": [8, 22], "exampl": [8, 9, 15, 19, 23, 24, 26, 27], "code": [8, 13, 15, 19], "conduct": [8, 13], "why": [8, 10, 15, 24, 26], "you": [8, 12, 14, 18, 21, 22, 24, 27], "need": [8, 26], "should": [9, 10, 11, 12, 13], "contain": [9, 10, 13], "develop": [10, 18], "import": [10, 12, 26], "That": 11, "repositori": [11, 12, 22], "have": 12, "licens": 12, "make": [12, 19], "sure": 12, "close": 12, "follow": 12, "guidelin": [12, 13, 21], "outlin": 12, "chose": [12, 24], "readm": 13, "resourc": 13, "name": 13, "badg": 13, "current": 13, "version": [13, 27], "continu": 13, "integr": 13, "coverag": 13, "A": [13, 22], "short": 13, "easi": 13, "understand": 13, "descript": 13, "doe": [13, 15, 26], "instal": 13, "ani": 13, "addit": 13, "setup": [13, 23, 27], "requir": [13, 21, 26], "brief": 13, "demonstr": 13, "link": 13, "tutori": [13, 14], "too": [13, 15], "much": [13, 15], "Of": 13, "good": [13, 16], "thing": 13, "commun": [13, 22], "citat": 13, "inform": [13, 21], "run": [14, 15, 19], "when": 14, "galleri": 14, "benefit": [14, 23, 26], "challeng": [14, 24, 26], "nbsphinx": 14, "jupyt": 14, "notebook": 14, "api": 15, "docstr": 15, "an": [15, 24], "relat": 15, "three": 15, "format": [15, 19], "we": [15, 24], "like": [15, 26, 27], "numpi": 15, "style": [15, 19], "better": 15, "best": 15, "function": 15, "doctest": 15, "method": 15, "ad": 15, "hint": 15, "bewar": 15, "gradual": 15, "face": [16, 17], "core": [16, 26], "compon": 16, "write": [16, 17], "usabl": 16, "four": 16, "land": 16, "welcom": 18, "enthusiast": 18, "goal": 18, "who": 18, "guidebook": 18, "where": [18, 22], "head": 18, "linter": 19, "life": 19, "easier": 19, "lint": 19, "formatt": 19, "styler": 19, "black": 19, "blue": 19, "flake8": 19, "isort": 19, "applic": 19, "workflow": [19, 24], "favorit": 19, "pre": 19, "commit": 19, "hook": 19, "check": 19, "set": 19, "up": 19, "git": [19, 27], "summari": [19, 24], "complex": [20, 23], "pure": [20, 24], "languag": 20, "learn": [21, 24], "here": [21, 24], "recommend": 21, "suggest": [21, 24], "ar": [21, 26], "pypi": 22, "anaconda": 22, "cloud": 22, "conda": 22, "channel": 22, "pip": 22, "manag": [22, 27], "depend": [22, 24], "conflict": 22, "take": 22, "awai": 22, "If": 22, "both": 22, "forg": 22, "accommod": 22, "more": [22, 24], "submit": 22, "maintain": 22, "pyproject": [23, 27], "toml": [23, 27], "configur": 23, "metadata": 23, "py": 23, "still": 23, "pdm": [23, 24, 27], "setuptool": [23, 24, 27], "hatch": [24, 27], "poetri": 24, "front": 24, "end": [24, 27], "back": [24, 27], "step": 24, "simplifi": 24, "choos": 24, "support": 24, "non": 24, "ecosystem": 24, "do": [24, 26], "featur": 24, "tabl": 24, "c": 24, "flit": 24, "about": [24, 26], "might": 24, "want": 24, "pin": 24, "wheel": [25, 26], "distribut": [25, 26], "sdist": 25, "archiv": 25, "whl": 25, "scientif": 26, "project": 26, "never": 26, "specif": 26, "peer": 26, "src": 26, "layout": 26, "discov": 26, "priorit": 26, "modul": 26, "sometim": 26, "includ": 26, "data": 26, "don": 26, "t": 26, "suit": 26, "dataset": 26, "flat": 26, "most": 26, "new": 27, "semver": 27, "rule": 27, "avoid": 27, "manual": 27, "updat": 27, "number": 27, "semant": 27, "releas": 27, "control": 27, "base": 27, "bump": 27, "offer": 27, "increment": 27, "pro": 27, "con": 27, "hatch_vc": 27, "hatchl": 27, "3": 27, "scm": 27, "tag": 27, "setuptools_scm": 27, "4": 27}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Contributing Guide for the Python open source software packaging book": [[0, "contributing-guide-for-the-python-open-source-software-packaging-book"]], "How this guide structured": [[0, "how-this-guide-structured"]], "Instructions for building the documentation locally on your computer": [[0, "instructions-for-building-the-documentation-locally-on-your-computer"]], "CI and Testing - Coming Soon!": [[1, "ci-and-testing-coming-soon"]], "Tools to Build and Host your Documentation": [[2, "tools-to-build-and-host-your-documentation"]], "Documentation syntax: markdown vs. myST vs. rst syntax to create your docs": [[3, "documentation-syntax-markdown-vs-myst-vs-rst-syntax-to-create-your-docs"]], "How to publish your Python package documentation online": [[4, "how-to-publish-your-python-package-documentation-online"]], "What is Read the Docs ?": [[4, "what-is-read-the-docs"]], "What is GitHub Pages?": [[4, "what-is-github-pages"]], "Read the Docs vs GitHub Pages": [[4, "read-the-docs-vs-github-pages"]], "Using Sphinx to Build Python Package Documentation": [[5, "using-sphinx-to-build-python-package-documentation"]], "Sphinx - a static site generator": [[5, "sphinx-a-static-site-generator"]], "Sphinx sites can be customized using extensions and themes": [[5, "sphinx-sites-can-be-customized-using-extensions-and-themes"]], "Commonly used Sphinx themes": [[5, "commonly-used-sphinx-themes"]], "Optimizing your documentation so search engines (and other users) find it": [[6, "optimizing-your-documentation-so-search-engines-and-other-users-find-it"]], "Google Analytics": [[6, "google-analytics"]], "sphinx-sitemap for search engine optimization": [[6, "sphinx-sitemap-for-search-engine-optimization"]], "sphinxext.opengraph": [[6, "sphinxext-opengraph"]], "Documentation for your Open Source Python Package": [[7, "documentation-for-your-open-source-python-package"]], "Documentation is critical for your Python package\u2019s success": [[7, "documentation-is-critical-for-your-python-package-s-success"]], "Two types of Python package users": [[7, "two-types-of-python-package-users"]], "1. Basic Tool Users": [[7, "basic-tool-users"]], "2. Potential tool contributors": [[7, "potential-tool-contributors"]], "Documentation elements that pyOpenSci looks for reviewing a Python package": [[7, "documentation-elements-that-pyopensci-looks-for-reviewing-a-python-package"]], "What\u2019s next in this Python package documentation section?": [[7, "what-s-next-in-this-python-package-documentation-section"]], "The CODE_OF_CONDUCT.md file In Your Python Open Source Package": [[8, "the-code-of-conduct-md-file-in-your-python-open-source-package"]], "Example Code of Conduct files": [[8, null]], "Why you need a code of conduct": [[8, "why-you-need-a-code-of-conduct"]], "Contributing File in your Python Open Source Package": [[9, "contributing-file-in-your-python-open-source-package"]], "What a CONTRIBUTING.md file should contain": [[9, "what-a-contributing-md-file-should-contain"]], "Example contributing files": [[9, null]], "What the development guide for your Python package should contain": [[10, "what-the-development-guide-for-your-python-package-should-contain"]], "Why a development guide is important": [[10, "why-a-development-guide-is-important"]], "Documentation Files That Should be in your Python Package Repository": [[11, "documentation-files-that-should-be-in-your-python-package-repository"]], "Your repository should have a LICENSE.md file": [[12, "your-repository-should-have-a-license-md-file"]], "Important: make sure that you closely follow the guidelines outlines by the License that you chose": [[12, "important-make-sure-that-you-closely-follow-the-guidelines-outlines-by-the-license-that-you-chose"]], "README File Guidelines and Resources": [[13, "readme-file-guidelines-and-resources"]], "What your README.md file should contain": [[13, "what-your-readme-md-file-should-contain"]], "\u2714\ufe0f Your package\u2019s name": [[13, "your-package-s-name"]], "\u2714\ufe0f Badges for current package version, continuous integration and test coverage": [[13, "badges-for-current-package-version-continuous-integration-and-test-coverage"]], "\u2714\ufe0f A short, easy-to-understand description of what your package does": [[13, "a-short-easy-to-understand-description-of-what-your-package-does"]], "\u2714\ufe0f Installation instructions": [[13, "installation-instructions"]], "\u2714\ufe0f Document any additional setup required": [[13, "document-any-additional-setup-required"]], "\u2714\ufe0f Brief demonstration of how to use the package": [[13, "brief-demonstration-of-how-to-use-the-package"]], "\u2714\ufe0f Descriptive links to package documentation, short tutorials": [[13, "descriptive-links-to-package-documentation-short-tutorials"]], "Too Much Of A Good Thing": [[13, null]], "\u2714\ufe0f A Community Section with Links to Contributing Guide, Code of Conduct": [[13, "a-community-section-with-links-to-contributing-guide-code-of-conduct"]], "\u2714\ufe0f Citation information": [[13, "citation-information"]], "Create tutorials in your Python package documentation": [[14, "create-tutorials-in-your-python-package-documentation"]], "Create Python package tutorials that run when you build your docs": [[14, "create-python-package-tutorials-that-run-when-you-build-your-docs"]], "sphinx gallery:": [[14, "sphinx-gallery"]], "Sphinx Gallery benefits": [[14, "sphinx-gallery-benefits"]], "Sphinx gallery challenges": [[14, "sphinx-gallery-challenges"]], "nbsphinx - tutorials using Jupyter Notebooks": [[14, "nbsphinx-tutorials-using-jupyter-notebooks"]], "Document the code in your package\u2019s API using docstrings": [[15, "document-the-code-in-your-package-s-api-using-docstrings"]], "What is an API?": [[15, "what-is-an-api"]], "What is a docstring and how does it relate to documentation?": [[15, "what-is-a-docstring-and-how-does-it-relate-to-documentation"]], "Python package API documentation": [[15, "python-package-api-documentation"]], "Three Python docstring formats and why we like NumPy style": [[15, "three-python-docstring-formats-and-why-we-like-numpy-style"]], "Docstring examples Better and Best": [[15, "docstring-examples-better-and-best"]], "Best: a docstring with example use of the function": [[15, "best-a-docstring-with-example-use-of-the-function"]], "Using doctest to run docstring examples in your package\u2019s methods and functions": [[15, "using-doctest-to-run-docstring-examples-in-your-package-s-methods-and-functions"]], "Adding type hints to your docstrings": [[15, "adding-type-hints-to-your-docstrings"]], "Why use type hints": [[15, "why-use-type-hints"]], "Beware of too much type hinting": [[15, null]], "Gradually adding type hints": [[15, "gradually-adding-type-hints"]], "Create User Facing Documentation for your Python Package": [[16, "create-user-facing-documentation-for-your-python-package"]], "Core components of user-facing Python package documentation": [[16, "core-components-of-user-facing-python-package-documentation"]], "Write usable documentation": [[16, "write-usable-documentation"]], "Four elements of a good open source documentation landing page": [[16, "four-elements-of-a-good-open-source-documentation-landing-page"]], "Writing user-facing documentation for your Python package": [[17, "writing-user-facing-documentation-for-your-python-package"]], "pyOpenSci Python Open Source Package Development Guide": [[18, "pyopensci-python-open-source-package-development-guide"]], "Welcome, Python open source enthusiast!": [[18, "welcome-python-open-source-enthusiast"]], "pyOpenSci\u2019s packaging goals": [[18, "pyopensci-s-packaging-goals"]], "How this guide is created": [[18, "how-this-guide-is-created"]], "Who this guidebook is for": [[18, "who-this-guidebook-is-for"]], "What you will find in this guidebook": [[18, "what-you-will-find-in-this-guidebook"]], "Where this guide is headed": [[18, "where-this-guide-is-headed"]], "Python Package Code Style, Format and Linters": [[19, "python-package-code-style-format-and-linters"]], "Use a code format tool (or tools) to make your life easier": [[19, "use-a-code-format-tool-or-tools-to-make-your-life-easier"]], "Linting vs format and style": [[19, "linting-vs-format-and-style"]], "Code Linting": [[19, "code-linting"]], "Code Formatters (and stylers)": [[19, "code-formatters-and-stylers"]], "Code format and style": [[19, "code-format-and-style"]], "Black and Blue": [[19, "black-and-blue"]], "flake8 for linting code in Python packages": [[19, "flake8-for-linting-code-in-python-packages"]], "Isort": [[19, "isort"]], "Example application of isort": [[19, "example-application-of-isort"]], "How to use code formatter in your local workflow": [[19, "how-to-use-code-formatter-in-your-local-workflow"]], "Linters, code formatters and your favorite coding tools": [[19, "linters-code-formatters-and-your-favorite-coding-tools"]], "Use pre-commit hooks to run code formatters and linters on commits": [[19, "use-pre-commit-hooks-to-run-code-formatters-and-linters-on-commits"]], "Pre-commit hook example workflow": [[19, "pre-commit-hook-example-workflow"]], "General pre commit checks": [[19, "general-pre-commit-checks"]], "Pre-commit.ci": [[19, "pre-commit-ci"]], "Setting up a git pre-commit hook": [[19, "setting-up-a-git-pre-commit-hook"]], "Summary": [[19, "summary"]], "Complex Python package builds": [[20, "complex-python-package-builds"]], "Pure Python Packages vs. packages with extensions in other languages": [[20, "pure-python-packages-vs-packages-with-extensions-in-other-languages"]], "Python package structure information": [[21, "python-package-structure-information"]], "What you will learn here": [[21, "what-you-will-learn-here"]], "Guidelines for pyOpenSci\u2019s packaging recommendations": [[21, "guidelines-for-pyopensci-s-packaging-recommendations"]], "Suggestions in this guide are not pyOpenSci review requirements": [[21, null]], "Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud": [[22, "publishing-your-package-in-a-community-repository-pypi-or-anaconda-cloud"]], "What is PyPI": [[22, "what-is-pypi"]], "What is Anaconda Cloud and Conda?": [[22, "what-is-anaconda-cloud-and-conda"]], "Conda channels": [[22, "conda-channels"]], "Conda channels, PyPI, conda, pip - Where to publish your package": [[22, "conda-channels-pypi-conda-pip-where-to-publish-your-package"]], "Managing Python package dependency conflicts": [[22, "managing-python-package-dependency-conflicts"]], "Take-aways: If you can, publish on both PyPI and conda-forge to accommodate more users of your package": [[22, "take-aways-if-you-can-publish-on-both-pypi-and-conda-forge-to-accommodate-more-users-of-your-package"]], "How to submit to conda-forge": [[22, "how-to-submit-to-conda-forge"]], "Maintaining your conda-forge package repository": [[22, "maintaining-your-conda-forge-package-repository"]], "Use a pyproject.toml file for your package configuration & metadata": [[23, "use-a-pyproject-toml-file-for-your-package-configuration-metadata"]], "Benefits of using a pyproject.toml file": [[23, "benefits-of-using-a-pyproject-toml-file"]], "Setup.py is still useful for complex package builds": [[23, null]], "Example pyproject.toml for building using PDM": [[23, "example-pyproject-toml-for-building-using-pdm"]], "Example pyproject.toml for building using setuptools": [[23, "example-pyproject-toml-for-building-using-setuptools"]], "Python Package Build Tools": [[24, "python-package-build-tools"]], "Tools that we review here": [[24, "tools-that-we-review-here"]], "Summary of tools Hatch vs. PDM vs. Poetry (and setuptools)": [[24, "summary-of-tools-hatch-vs-pdm-vs-poetry-and-setuptools"]], "Build front-end vs. build back-end tools": [[24, "build-front-end-vs-build-back-end-tools"]], "Build back-ends": [[24, "build-back-ends"]], "Python package build front-ends": [[24, "python-package-build-front-ends"]], "Example build steps that can be simplified using a front-end tool": [[24, "example-build-steps-that-can-be-simplified-using-a-front-end-tool"]], "Choosing a build back-end": [[24, "choosing-a-build-back-end"]], "Build back-end support for non pure-python packages": [[24, "build-back-end-support-for-non-pure-python-packages"]], "An ecosystem of Python build tools": [[24, "an-ecosystem-of-python-build-tools"]], "We do not suggest using setuptools": [[24, null]], "Chose a build workflow tool": [[24, "chose-a-build-workflow-tool"]], "Python packaging tools summary": [[24, "python-packaging-tools-summary"]], "Package tool features table": [[24, "package-tool-features-table"]], "PDM": [[24, "pdm"]], "PDM support for C and C++ extensions": [[24, null]], "PDM Features": [[24, "pdm-features"]], "PDM vs. Poetry": [[24, null]], "Challenges with PDM": [[24, "challenges-with-pdm"]], "Flit": [[24, "flit"]], "Flit Features": [[24, "flit-features"]], "Learn more about flit": [[24, null]], "Why you might not want to use Flit": [[24, "why-you-might-not-want-to-use-flit"]], "Hatch": [[24, "hatch"]], "Hatch features": [[24, "hatch-features"]], "Why you might not want to use Hatch": [[24, "why-you-might-not-want-to-use-hatch"]], "Poetry": [[24, "poetry"]], "Poetry features": [[24, "poetry-features"]], "Challenges with Poetry": [[24, "challenges-with-poetry"]], "Challenges with Poetry dependency pinning": [[24, null]], "Using Setuptools Back-end for Python Packaging with Build Front-end": [[24, "using-setuptools-back-end-for-python-packaging-with-build-front-end"]], "Setuptools Features": [[24, "setuptools-features"]], "Challenges using setuptools": [[24, "challenges-using-setuptools"]], "The Python Package Source and Wheel Distributions": [[25, "the-python-package-source-and-wheel-distributions"]], "Source Distribution (sdist)": [[25, "source-distribution-sdist"]], "GitHub archive vs SDist": [[25, null]], "Wheel (.whl files):": [[25, "wheel-whl-files"]], "Python Package Structure for Scientific Python Projects": [[26, "python-package-structure-for-scientific-python-projects"]], "pyOpenSci will never require a specific package structure for peer review": [[26, null]], "Example scientific packages that use src/package layout": [[26, null]], "The src/ layout and testing": [[26, "the-src-layout-and-testing"]], "How Python discovers and prioritizes importing modules": [[26, null]], "Sometimes tests are needed in a distribution": [[26, "sometimes-tests-are-needed-in-a-distribution"]], "Challenges with including tests and data in a package wheel": [[26, null]], "Don\u2019t include test suite datasets in your package": [[26, "don-t-include-test-suite-datasets-in-your-package"]], "About the flat Python package layout": [[26, "about-the-flat-python-package-layout"]], "Why most scientific Python packages do not use source": [[26, null]], "What does the flat layout structure look like?": [[26, "what-does-the-flat-layout-structure-look-like"]], "Benefits of using the flat layout in your Python package": [[26, "benefits-of-using-the-flat-layout-in-your-python-package"]], "Core scientific Python packages that use the flat layout": [[26, null]], "Creating New Versions of Your Python Package": [[27, "creating-new-versions-of-your-python-package"]], "SemVer rules": [[27, "semver-rules"]], "Avoid manually updating Python package version numbers if you can": [[27, "avoid-manually-updating-python-package-version-numbers-if-you-can"]], "Tools to manage versions for your Python package": [[27, "tools-to-manage-versions-for-your-python-package"]], "Semantic release, vs version control based vs manual version bumping": [[27, "semantic-release-vs-version-control-based-vs-manual-version-bumping"]], "Tools for bumping Python package versions": [[27, "tools-for-bumping-python-package-versions"]], "Tool 1: Hatch and other build tools that offer incremental versioning": [[27, "tool-1-hatch-and-other-build-tools-that-offer-incremental-versioning"]], "Hatch (or other tools like PDM) Pros": [[27, "hatch-or-other-tools-like-pdm-pros"]], "Hatch (or other tools like PDM) Cons": [[27, "hatch-or-other-tools-like-pdm-cons"]], "Tool 2: Hatch_vcs & hatchling build back-end": [[27, "tool-2-hatch-vcs-hatchling-build-back-end"]], "Hatch example setup in your pyproject.toml": [[27, "hatch-example-setup-in-your-pyproject-toml"]], "hatch_vcs Pros": [[27, "hatch-vcs-pros"]], "hatch_vcs Cons": [[27, "hatch-vcs-cons"]], "Tool 3: setuptools-scm versioning using git tags": [[27, "tool-3-setuptools-scm-versioning-using-git-tags"]], "setuptools_scm Cons": [[27, "setuptools-scm-cons"]], "Tool 4: Python semantic release": [[27, "tool-4-python-semantic-release"]], "Python Semantic Release Pros": [[27, "python-semantic-release-pros"]], "Python Semantic Release Cons": [[27, "python-semantic-release-cons"]], "Python Packaging Tools\u2026 Coming soon\u2026": [[28, "python-packaging-tools-coming-soon"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["CONTRIBUTING", "ci-and-testing/intro", "documentation/hosting-tools/intro", "documentation/hosting-tools/myst-markdown-rst-doc-syntax", "documentation/hosting-tools/publish-documentation-online", "documentation/hosting-tools/sphinx-python-package-documentation-tools", "documentation/hosting-tools/website-hosting-optimizing-your-docs", "documentation/index", "documentation/repository-files/code-of-conduct-file", "documentation/repository-files/contributing-file", "documentation/repository-files/development-guide", "documentation/repository-files/intro", "documentation/repository-files/license-files", "documentation/repository-files/readme-file-best-practices", "documentation/write-user-documentation/create-package-tutorials", "documentation/write-user-documentation/document-your-code-api-docstrings", "documentation/write-user-documentation/get-started", "documentation/write-user-documentation/intro", "index", "package-structure-code/code-style-linting-format", "package-structure-code/complex-python-package-builds", "package-structure-code/intro", "package-structure-code/publish-python-package-pypi-conda", "package-structure-code/pyproject-toml-python-package-metadata", "package-structure-code/python-package-build-tools", "package-structure-code/python-package-distribution-files-sdist-wheel", "package-structure-code/python-package-structure", "package-structure-code/python-package-versions", "python-packaging/intro"], "filenames": ["CONTRIBUTING.md", "ci-and-testing/intro.md", "documentation/hosting-tools/intro.md", "documentation/hosting-tools/myst-markdown-rst-doc-syntax.md", "documentation/hosting-tools/publish-documentation-online.md", "documentation/hosting-tools/sphinx-python-package-documentation-tools.md", "documentation/hosting-tools/website-hosting-optimizing-your-docs.md", "documentation/index.md", "documentation/repository-files/code-of-conduct-file.md", "documentation/repository-files/contributing-file.md", "documentation/repository-files/development-guide.md", "documentation/repository-files/intro.md", "documentation/repository-files/license-files.md", "documentation/repository-files/readme-file-best-practices.md", "documentation/write-user-documentation/create-package-tutorials.md", "documentation/write-user-documentation/document-your-code-api-docstrings.md", "documentation/write-user-documentation/get-started.md", "documentation/write-user-documentation/intro.md", "index.md", "package-structure-code/code-style-linting-format.md", "package-structure-code/complex-python-package-builds.md", "package-structure-code/intro.md", "package-structure-code/publish-python-package-pypi-conda.md", "package-structure-code/pyproject-toml-python-package-metadata.md", "package-structure-code/python-package-build-tools.md", "package-structure-code/python-package-distribution-files-sdist-wheel.md", "package-structure-code/python-package-structure.md", "package-structure-code/python-package-versions.md", "python-packaging/intro.md"], "titles": ["Contributing Guide for the Python open source software packaging book", "CI and Testing - Coming Soon!", "Tools to Build and Host your Documentation", "Documentation syntax: markdown vs. myST vs. rst syntax to create your docs", "How to publish your Python package documentation online", "Using Sphinx to Build Python Package Documentation", "Optimizing your documentation so search engines (and other users) find it", "Documentation for your Open Source Python Package", "The CODE_OF_CONDUCT.md file In Your Python Open Source Package", "Contributing File in your Python Open Source Package", "What the development guide for your Python package should contain", "Documentation Files That Should be in your Python Package Repository", "Your repository should have a LICENSE.md file", "README File Guidelines and Resources", "Create tutorials in your Python package documentation", "Document the code in your package\u2019s API using docstrings", "Create User Facing Documentation for your Python Package", "Writing user-facing documentation for your Python package", "pyOpenSci Python Open Source Package Development Guide", "Python Package Code Style, Format and Linters", "Complex Python package builds", "Python package structure information", "Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud", "Use a pyproject.toml file for your package configuration & metadata", "Python Package Build Tools", "The Python Package Source and Wheel Distributions", "Python Package Structure for Scientific Python Projects", "Creating New Versions of Your Python Package", "Python Packaging Tools\u2026 Coming soon\u2026"], "terms": {"i": [0, 1, 2, 3, 5, 6, 8, 11, 12, 13, 14, 16, 19, 20, 21, 24, 25, 26, 27, 28], "commun": [0, 5, 6, 7, 8, 11, 16, 18, 21, 24, 26], "resourc": [0, 18, 20, 23], "we": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 13, 14, 16, 17, 18, 19, 20, 21, 22, 23, 25, 26, 27, 28], "welcom": [0, 5, 7, 9], "form": 0, "issu": [0, 6, 7, 9, 16, 18, 19, 20, 24, 26], "pull": [0, 4, 9, 10, 14, 19, 22], "request": [0, 4, 9, 10, 14, 19, 22, 24], "If": [0, 3, 4, 6, 7, 8, 10, 12, 13, 14, 15, 18, 19, 20, 21, 24, 25, 26, 27], "you": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 13, 15, 16, 17, 19, 20, 23, 25, 26], "have": [0, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 18, 19, 20, 21, 22, 24, 25, 26, 27], "an": [0, 3, 6, 7, 10, 11, 12, 13, 14, 16, 18, 19, 20, 21, 22, 23, 25, 26, 27], "idea": [0, 18], "someth": [0, 7], "should": [0, 1, 7, 8, 14, 15, 16, 17, 18, 19, 21, 22, 24], "includ": [0, 2, 4, 5, 7, 8, 9, 10, 13, 14, 15, 16, 18, 19, 22, 23, 24, 25, 27], "pleas": [0, 7, 13, 20, 21], "here": [0, 5, 7, 8, 12, 13, 16, 17, 18, 19, 22, 23, 25, 26, 27], "find": [0, 3, 7, 13, 15, 16, 19, 21, 22, 24, 27], "typo": 0, "feel": [0, 15], "free": [0, 4, 5, 6, 18], "submit": [0, 6, 7, 9, 10, 13, 18, 19, 21], "modifi": [0, 14, 19, 27], "text": [0, 3, 8, 10, 14, 15, 18, 27], "directli": [0, 19, 22, 24, 25, 26], "Or": [0, 7, 16, 22], "ar": [0, 2, 3, 4, 5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 27], "less": [0, 13, 14, 19, 24], "comfort": [0, 3, 8], "want": [0, 3, 4, 5, 6, 8, 13, 14, 15, 18, 19, 20, 22, 26, 27], "see": [0, 5, 7, 8, 9, 11, 13, 14, 15, 16, 18, 19, 20, 21, 23, 24, 26, 27], "larger": [0, 26], "chang": [0, 10, 18, 19, 22, 24, 26, 27], "content": [0, 6, 7, 13, 25, 27], "first": [0, 13, 23, 24, 25, 26], "most": [0, 2, 3, 5, 6, 18, 21, 22, 24, 27], "repositori": [0, 4, 7, 8, 9, 10, 13, 19, 23, 24, 25, 26, 27, 28], "sphinx": [0, 2, 3, 15, 16, 17], "engin": 0, "built": [0, 6, 19, 22, 24, 25, 27, 28], "us": [0, 2, 3, 4, 6, 7, 8, 10, 11, 12, 16, 18, 20, 21, 22, 25], "theme": [0, 6], "myst": [0, 2, 5, 16], "syntax": [0, 2, 5, 16, 18, 19], "creat": [0, 4, 5, 8, 10, 13, 15, 17, 19, 21, 22, 24, 25, 26], "each": [0, 6, 7, 8, 14, 15, 16, 18, 19, 21, 23, 24], "page": [0, 5, 6, 13, 14, 15, 18, 20, 21, 22, 24, 26], "wish": [0, 4, 7, 10, 19, 20, 24], "work": [0, 4, 10, 14, 15, 18, 19, 22, 23, 24, 26, 27], "need": [0, 3, 4, 7, 10, 14, 15, 16, 19, 20, 21, 23, 24, 25, 27], "fork": [0, 22], "clone": 0, "The": [0, 2, 3, 4, 5, 6, 7, 9, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 22, 23, 24, 27], "easiest": [0, 21], "wai": [0, 2, 4, 13, 16, 19, 21, 24, 25, 27], "nox": [0, 24], "tool": [0, 3, 5, 6, 8, 12, 13, 14, 15, 16, 18, 20, 21, 22, 23, 26], "quickli": [0, 4, 13, 14, 15, 16], "environ": [0, 4, 10, 14, 19, 22, 24, 25, 26], "run": [0, 4, 5, 10, 24, 25, 26, 27], "command": [0, 15, 19, 24, 27], "within": [0, 13, 15, 16, 19, 21, 22, 26, 27], "them": [0, 7, 13, 15, 19, 24], "ensur": [0, 14, 15, 18, 19, 21, 22, 24, 26, 27], "ha": [0, 3, 10, 12, 13, 14, 16, 18, 19, 20, 22, 23, 24, 25, 26, 27], "all": [0, 7, 11, 13, 14, 15, 16, 18, 19, 22, 23, 24, 25, 26], "depend": [0, 7, 20, 23, 25, 26, 27, 28], "To": [0, 12, 14, 15, 16, 19, 21, 22, 24, 27], "do": [0, 4, 6, 13, 15, 16, 19, 22, 27], "so": [0, 7, 13, 19, 21, 22, 24, 25], "follow": [0, 6, 10, 11, 13, 15, 16, 19, 21, 22, 24, 25, 26, 27], "step": [0, 15, 16, 20, 22, 25, 26, 27], "instal": [0, 7, 16, 19, 20, 22, 24, 25, 26], "pip": [0, 19, 24, 25], "": [0, 3, 4, 5, 8, 9, 10, 12, 14, 16, 17, 19, 22, 23, 24, 25, 26, 27], "docs_build": 0, "folder": [0, 21, 22, 26], "specifi": [0, 10, 13, 14, 15, 16, 19, 23, 24], "noxfil": 0, "py": [0, 6, 14, 15, 19, 25, 26, 27], "configur": [0, 14, 19, 24, 25, 26, 27], "output": [0, 14, 15, 19], "_build": [0, 14], "html": [0, 3, 5, 14], "live": [0, 10, 14, 21, 26], "updat": [0, 7, 8, 10, 19, 22, 23, 24], "when": [0, 2, 6, 10, 11, 12, 13, 15, 16, 18, 19, 21, 22, 24, 25, 26, 27], "file": [0, 3, 4, 5, 6, 7, 10, 14, 15, 16, 19, 21, 22, 24, 26, 27], "docs_liv": 0, "thi": [1, 2, 5, 6, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 22, 23, 24, 25, 26, 27, 28], "section": [1, 2, 11, 14, 15, 16, 17, 18, 21, 23, 24, 25, 26, 27, 28], "evolv": [1, 7, 21], "publish": [1, 2, 13, 16, 21, 24, 25, 27, 28], "end": [1, 19, 20, 21, 23, 28], "spring": 1, "2023": [1, 28], "common": [2, 5, 12, 13, 22, 24], "python": [2, 3, 13, 23], "ecosystem": [2, 3, 5, 13, 15, 19, 21, 26, 27], "current": [2, 5, 6, 21, 24, 26, 27, 28], "howev": [2, 3, 4, 5, 6, 7, 14, 15, 19, 20, 21, 22, 24, 25, 26, 27], "some": [2, 4, 6, 8, 10, 13, 14, 15, 16, 18, 19, 21, 22, 23, 24, 26, 27], "maintain": [2, 4, 8, 10, 13, 15, 18, 19, 21, 23, 24, 26, 27], "like": [2, 6, 7, 9, 13, 14, 18, 19, 22, 24, 25], "mkdoc": [2, 5], "It": [2, 3, 6, 7, 8, 9, 10, 13, 14, 15, 18, 19, 21, 22, 23, 24, 26, 27], "up": [2, 7, 10, 13, 15, 24, 26, 27], "platform": [2, 11, 25], "prefer": [2, 3, 5, 7, 14, 19, 24, 27], "In": [2, 7, 11, 13, 15, 19, 20, 21, 23, 24, 25, 26, 27, 28], "introduc": [2, 24], "talk": [2, 17], "about": [2, 3, 9, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 25, 27], "variou": [2, 21, 22, 24], "option": [2, 3, 4, 6, 13, 21, 22, 24, 27], "can": [2, 3, 4, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 23, 25, 26], "write": [2, 3, 5, 7, 13, 14, 15, 19, 24, 27], "rst": [2, 5, 14], "also": [2, 4, 7, 8, 9, 10, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27], "onlin": [2, 11, 12, 13, 22], "might": [2, 3, 7, 8, 13, 15, 16, 17, 19, 21, 22, 26, 27], "help": [2, 6, 7, 10, 13, 15, 16, 18, 19, 20, 21, 24, 27], "optim": 2, "websit": [2, 3, 4, 5, 6, 7, 10, 12, 13, 16, 26], "There": [3, 13, 14, 15, 20, 22, 24, 25, 26, 27], "three": [3, 18, 20, 27], "commonli": [3, 4, 7, 18, 19, 24, 26, 27], "easi": [3, 14, 16, 23, 24, 27], "learn": [3, 18, 19, 22, 25, 26], "default": [3, 14, 19, 22, 24, 26], "jupyt": [3, 26], "notebook": [3, 26], "add": [3, 5, 6, 12, 13, 14, 15, 19, 20, 22, 24, 26, 27], "allow": [3, 4, 6, 10, 14, 15, 18, 19, 20, 21, 22, 23, 24, 27], "render": [3, 14], "limit": [3, 22, 24, 25], "For": [3, 14, 15, 19, 20, 24, 25, 26, 27], "instanc": [3, 15, 19, 20, 24, 27], "refer": [3, 4, 15, 16, 19, 24, 25, 27], "color": 3, "call": [3, 9, 15, 19, 20, 22, 23, 25, 27], "out": [3, 10, 14, 19, 21, 22, 23, 24, 26], "block": [3, 19], "other": [3, 4, 5, 7, 8, 11, 12, 13, 18, 19, 21, 22, 24, 25, 26], "custom": [3, 4, 20, 24], "element": [3, 6, 11, 14, 15, 17], "either": [3, 20, 24], "restructur": 3, "nativ": [3, 5], "support": [3, 4, 5, 6, 7, 14, 15, 16, 18, 20, 21, 22, 23, 25, 26, 27, 28], "wa": [3, 19, 22, 27], "mani": [3, 4, 6, 8, 11, 14, 16, 18, 19, 20, 21, 22, 24, 26, 27], "year": 3, "recent": 3, "risen": 3, "top": [3, 13, 14, 19], "favorit": 3, "given": [3, 16, 26, 27], "flexibl": [3, 18, 21, 24], "combin": [3, 14], "vanilla": 3, "nice": [3, 10, 14], "becaus": [3, 15, 18, 19, 22, 24, 25, 27], "offer": [3, 4, 6, 24], "both": [3, 7, 11, 13, 14, 15, 16, 19, 21, 24, 25, 26, 27], "rich": 3, "function": [3, 5, 14, 16, 17, 18, 19, 20, 24, 25, 26, 27], "simpl": [3, 7, 13, 15, 16, 20, 21, 22, 23, 24, 26], "while": [3, 5, 6, 10, 19, 22, 23, 24, 25, 26, 27], "chose": [3, 6, 15, 19, 20], "ani": [3, 9, 10, 12, 16, 18, 19, 22, 24, 25, 27], "list": [3, 6, 7, 12, 13, 14, 15, 16, 18, 19, 24], "abov": [3, 10, 11, 13, 15, 16, 19, 24, 26, 27], "suggest": [3, 4, 7, 15, 19, 20, 26, 27], "simpler": [3, 20, 27], "thu": [3, 12, 13, 15, 22, 24, 25, 26, 27], "easier": [3, 5, 14, 15, 17, 18, 22, 24], "simplic": 3, "make": [3, 6, 10, 14, 15, 16, 17, 18, 22, 24, 25, 26, 27], "more": [3, 4, 6, 7, 13, 15, 16, 18, 19, 20, 21, 25, 26, 27], "peopl": [3, 6, 7, 8, 16, 18, 22, 26, 27], "contribut": [3, 7, 8, 10, 15, 16, 18, 19, 25, 26], "core": [3, 6, 15, 18, 19, 21, 22, 24, 25], "packag": [3, 6, 12], "readm": [3, 7, 9, 11, 16, 23, 24, 25, 26], "md": [3, 7, 10, 14, 16, 23, 25, 26], "alreadi": [3, 24, 25, 26], "format": [3, 4, 10, 14, 21, 23, 25, 27], "github": [3, 7, 11, 12, 13, 14, 16, 18, 19, 20, 22, 23, 27], "wide": [3, 15, 27], "scientif": [3, 5, 13, 15, 18, 19, 21, 22, 24, 27], "fenc": 3, "setup": [4, 10, 14, 19, 20, 21, 24, 25], "host": [4, 7, 26], "servic": 4, "two": [4, 14, 15, 16, 22, 23, 25, 26], "below": [4, 7, 11, 13, 14, 15, 16, 18, 19, 20, 22, 23, 24, 25, 26, 27], "yourself": [4, 8, 26], "anoth": [4, 11, 13, 14, 15, 20, 22, 24], "project": [4, 12, 13, 16, 23, 24, 25, 27], "fulli": [4, 24, 27], "featur": [4, 10, 16, 20, 21, 26, 27], "its": [4, 7, 15, 16, 24, 25], "paid": 4, "tier": 4, "autom": [4, 27], "build": [4, 7, 10, 13, 15, 18, 21, 22, 25, 26, 28], "turn": [4, 20, 27], "integr": [4, 10, 18, 22, 25], "where": [4, 14, 16, 19, 21, 23, 24, 27], "view": [4, 5, 7, 15, 18, 23, 24], "progress": [4, 18], "success": 4, "failur": 4, "version": [4, 15, 18, 19, 22, 23, 24, 25, 26], "which": [4, 5, 8, 13, 15, 18, 19, 21, 22, 24, 26, 27], "user": [4, 5, 8, 9, 10, 12, 13, 14, 15, 18, 24, 25, 26, 27], "older": [4, 24], "tag": [4, 6, 23, 24], "thei": [4, 6, 7, 8, 10, 13, 14, 16, 19, 21, 22, 24, 26, 27], "download": [4, 14], "pdf": 4, "readthedoc": 4, "yaml": [4, 19], "web": [4, 6, 24], "local": [4, 10, 22, 24, 26, 27], "continu": [4, 10, 18, 22], "push": [4, 22, 27], "branch": 4, "great": [4, 13, 15, 21, 24], "deploy": 4, "bit": 4, "deploi": 4, "account": 4, "entir": [4, 6, 19], "process": [4, 10, 15, 18, 19, 21, 22], "don": [4, 7, 13, 15, 19, 24], "t": [4, 7, 13, 15, 18, 19, 22, 24, 25, 27], "On": [5, 14, 22], "discuss": [5, 7, 10, 12, 15, 16, 18, 19, 20, 22, 24, 25, 26, 27], "your": [5, 18, 20, 21, 24, 25, 28], "face": [5, 7, 15, 18, 26], "explor": [5, 14, 21], "gain": 5, "popular": [5, 6, 12, 24], "exampl": [5, 7, 11, 12, 13, 14, 16, 22, 25], "love": [5, 18], "geopanda": [5, 15, 16], "land": [5, 13, 14], "verd": [5, 9, 15], "code": [5, 7, 9, 10, 11, 12, 14, 16, 17, 18, 20, 21, 24, 25, 26, 27], "our": [5, 7, 18, 20, 21, 23, 24, 26], "A": [5, 7, 9, 10, 14, 15, 16, 18, 19, 21, 24, 25, 27], "base": [5, 6, 7, 10, 14, 15, 19, 21, 24], "upon": [5, 21, 24, 26, 27], "set": [5, 6, 7, 10, 14, 18, 24, 25, 26, 27], "templat": 5, "serv": [5, 13, 24], "mean": [5, 15, 24, 25, 26, 27], "modif": 5, "fly": 5, "written": [5, 16, 20, 21, 22, 23, 24], "extend": [5, 19], "few": [5, 13, 19, 20, 21, 24, 25, 26], "appli": [5, 12, 13, 15, 19, 27], "quick": [5, 13, 16, 24], "beauti": 5, "automat": [5, 12, 18, 19, 27], "class": [5, 14, 15, 16, 17], "api": [5, 14, 16, 17, 23, 27], "from": [5, 6, 7, 8, 10, 11, 12, 13, 14, 15, 16, 18, 19, 21, 22, 24, 25, 26, 27], "docstr": [5, 10, 16, 19], "autodoc": [5, 15, 17], "test": [5, 7, 10, 14, 15, 18, 21, 22, 24, 25, 27], "doctest": 5, "parser": 5, "whatev": [5, 25], "pydata": [5, 6], "book": [5, 6], "furo": 5, "interest": [6, 9, 19], "mai": [6, 8, 10, 14, 15, 16, 19, 21, 22, 23, 24, 25, 26, 27], "extens": [6, 14, 15, 17, 18, 21, 25, 27], "compliant": 6, "european": 6, "gener": [6, 15, 16, 20, 22, 24, 25, 27], "data": [6, 7, 14, 15, 22, 24], "protect": [6, 8], "regul": 6, "gdpr": 6, "compon": [6, 20], "one": [6, 9, 15, 19, 21, 24, 27], "let": [6, 13, 16, 19], "know": [6, 7, 13, 15, 24, 27], "site": [6, 13, 20], "collect": [6, 13, 19], "consent": 6, "possibl": [6, 16], "infrastructur": [6, 7, 18, 19], "around": [6, 8, 13, 18, 19, 21, 27], "close": [6, 18, 19, 27], "slowli": 6, "shift": 6, "awai": [6, 19], "open": [6, 12, 19, 20, 21, 22, 24, 26], "plausibl": 6, "cloudflar": 6, "matomo": 6, "pyopensci": [6, 10, 12, 13, 19, 22, 23, 27], "look": [6, 11, 14, 18, 19, 21, 24, 25], "sourc": [6, 12, 19, 21, 22, 27], "develop": [6, 7, 9, 12, 13, 15, 16, 19, 21, 22, 23, 24, 26, 27, 28], "doe": [6, 14, 19, 24, 25, 27], "sphinxcontrib": 6, "gtagj": 6, "try": [6, 13, 21, 22], "move": [6, 11, 13, 18, 24, 26], "complianc": 6, "privaci": 6, "still": [6, 7, 24, 27], "import": [6, 7, 8, 13, 15, 19, 21, 24, 25, 27], "And": [6, 14, 15, 19, 21, 22, 24], "xml": 6, "index": [6, 14, 26], "over": [6, 13, 24, 26], "time": [6, 10, 13, 14, 15, 19, 20, 22, 24, 26, 27], "visibl": 6, "lightweight": 6, "requir": [6, 7, 10, 12, 15, 18, 19, 20, 22, 23, 24, 25, 27], "conf": [6, 14, 15], "url": 6, "metadata": [6, 24, 25, 26, 27], "protocol": [6, 21], "provid": [6, 13, 14, 15, 16, 19, 20, 21, 22, 23, 24, 27], "preview": 6, "share": [6, 12, 18, 21], "social": 6, "media": 6, "twitter": 6, "mastodon": 6, "even": [6, 15, 19, 24, 27], "slack": 6, "discours": [6, 20], "note": [7, 16, 20, 24, 25, 26, 27], "those": [7, 14, 15, 16, 19, 21, 22, 24, 26, 27], "As": [7, 15, 20, 24, 25, 26, 27], "guid": [7, 9, 11, 12, 15, 16, 20, 23, 24, 26, 27], "peer": [7, 18, 19, 21, 27], "focus": [7, 14, 19, 20, 22], "toctre": 7, "hidden": [7, 27], "best": [7, 17, 18, 19, 21, 22, 24, 26], "practic": [7, 17, 18, 21, 27], "doc": [7, 13, 15, 24, 26], "licens": [7, 9, 11, 13, 18, 23, 25, 26], "itself": [7, 8, 13, 19, 21], "qualiti": [7, 13, 15], "cours": 7, "valuabl": [7, 10, 19], "how": [7, 8, 9, 10, 11, 12, 16, 17, 23, 24, 27], "get": [7, 12, 13, 14, 15, 16, 18, 19, 21, 22, 24, 26], "task": [7, 15, 24], "done": [7, 19, 20], "understand": [7, 15, 18, 19, 24, 26, 27], "workflow": [7, 10, 15, 16, 18, 20, 21, 25, 26, 27, 28], "won": [7, 19, 24, 26], "further": [7, 15, 20], "explicitli": [7, 24], "target": 7, "who": [7, 16, 17, 21, 22, 26], "new": [7, 10, 14, 15, 18, 19, 21, 22, 24, 26], "er": 7, "scienc": [7, 10], "expert": [7, 16, 18], "programm": [7, 15, 16], "But": [7, 24, 27], "background": [7, 13], "softwar": [7, 12, 18], "These": [7, 8, 14, 18, 19, 20, 21, 22, 24, 25, 26, 27], "start": [7, 13, 14, 15, 16, 18, 19, 21, 24, 26], "inform": [7, 9, 10, 18, 23, 26], "cite": [7, 13], "give": [7, 19], "credit": 7, "research": 7, "applic": [7, 13], "oper": [7, 14, 15, 19, 23, 24, 25, 27], "subset": 7, "experienc": 7, "engag": [7, 8], "abl": [7, 27], "bug": [7, 8, 22, 27], "fix": [7, 8, 19, 24, 27], "just": [7, 10, 20, 21, 24, 26], "spell": 7, "error": [7, 18, 19, 27], "tutori": [7, 15, 16, 17, 23, 26], "thing": [7, 9, 10, 18, 19, 24], "d": [7, 9, 13, 18, 19, 24], "guidelin": [7, 9, 10, 18, 19, 27], "clarifi": 7, "rememb": [7, 19], "definit": [7, 15, 19], "broad": [7, 16, 22], "could": [7, 19, 20, 24, 25, 27], "report": 7, "cover": [7, 10, 14, 17, 18, 23, 28], "edg": 7, "case": [7, 10, 14, 15, 16, 18, 19, 20, 23, 24, 25, 26, 27], "discov": [7, 19, 24], "structur": [7, 14, 15, 18, 19, 23, 24], "specif": [7, 10, 15, 19, 20, 21, 22, 24, 25, 27], "found": [7, 9, 16, 19, 22, 23, 24, 26, 27], "check": [7, 14, 15, 21, 22, 24, 26, 27], "link": [7, 9, 10, 11, 14, 16, 27], "consid": [7, 8, 10, 12, 13, 15, 16, 17, 18, 21, 22, 24, 26, 27], "detail": [7, 16, 18, 19, 22, 24, 26, 27], "movingpanda": [7, 11, 13, 22], "major": [7, 18, 24, 27], "code_of_conduct": [7, 25, 26], "txt": [7, 12, 25, 26], "screen": [7, 11, 13], "shot": [7, 11, 13], "taken": [7, 11, 13], "nov": [7, 11, 13], "23": [7, 11, 13], "2022": [7, 11, 13], "walk": [7, 17], "through": [7, 12, 13, 17, 18, 24], "scipi": [8, 12, 21, 26], "notic": [8, 11, 14, 15, 16, 19, 23, 26], "theirs": 8, "document": [8, 10, 12, 18, 21, 24, 26, 27], "fatiando": [8, 9], "locat": [8, 9, 13, 19, 26, 27], "root": [8, 9, 12, 13, 19, 26], "onc": [8, 13, 19, 22], "question": [8, 9, 16, 20, 22, 24], "encount": [8, 22, 26], "challeng": 8, "team": [8, 19, 22, 24, 27], "order": [8, 10, 15, 19], "keep": [8, 11, 15, 16, 18, 22, 24, 27], "healthi": 8, "mainatian": 8, "unhealthi": 8, "behavior": [8, 24], "establish": 8, "what": [8, 12, 14, 16, 19, 24, 25, 27], "expect": [8, 15], "term": [8, 12, 13, 16, 24], "contributor": [8, 10, 13, 14, 15, 18, 19, 23, 24, 27], "interact": [8, 24], "rule": [8, 18, 19], "enforc": [8, 19, 27], "harm": 8, "neg": 8, "own": [8, 24], "encourag": [8, 18, 22, 24], "adopt": [8, 21, 24, 27], "languag": [8, 13, 16, 18, 21, 22, 23, 24, 25, 26, 27], "coven": 8, "terra": 8, "geoscienc": 8, "pygmt": 9, "type": [9, 10, 14, 16, 17, 19, 20, 22, 24, 27], "happen": [9, 27], "someon": [9, 13, 14, 16, 23, 26], "ask": [9, 13, 16, 24], "place": [9, 18, 24, 26], "conduct": [9, 11], "ideal": [10, 13, 14, 16, 22, 24], "clearli": [10, 13], "show": [10, 11, 13, 14, 15, 21, 24], "technic": [10, 13, 16], "profici": 10, "suit": [10, 13, 14, 15, 18, 19, 21, 22], "standard": [10, 19, 21, 22, 23, 24, 27], "style": [10, 18, 21], "approach": [10, 21, 24, 26, 27], "exist": [10, 18, 21, 22, 26, 27], "releas": [10, 24, 25], "onboard": 10, "inclin": 10, "thought": [10, 27], "mainten": [10, 13, 14, 18, 26, 27], "futur": [10, 15, 20, 23, 24, 27], "well": [10, 11, 13, 14, 15, 16, 18, 21, 24, 27], "skip": 10, "especi": [10, 15, 24, 26], "strongli": [10, 24, 26], "recommend": [10, 18, 24, 26, 27], "elig": 10, "review": [10, 11, 12, 13, 14, 18, 19, 22, 27], "opt": 10, "mozilla": 10, "lab": 10, "outlin": 10, "minimum": [11, 18, 21], "mention": [11, 13, 24], "etc": [11, 19, 23], "measur": [11, 13], "health": [11, 13], "evalu": [11, 13], "avail": [11, 13, 19, 21, 22, 27], "among": 11, "level": [11, 13, 14, 15, 16, 20, 21, 26, 27], "repo": [11, 16, 19, 20, 24, 27], "snyk": [11, 13], "known": [11, 22], "compani": 11, "tab": [11, 24], "similar": [11, 13, 15, 19, 24, 25], "screenshot": 11, "panda": [11, 13, 26], "approv": [12, 18, 22, 23], "initi": [12, 15, 19], "osi": [12, 18, 23], "handi": 12, "choos": 12, "copi": 12, "everi": [12, 15, 19, 22], "differ": [12, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27], "borrow": 12, "compli": 12, "select": [12, 18, 20, 21, 24], "would": [12, 19, 26, 27], "bsd": [12, 23], "mit": 12, "stackoverflow": 12, "stack": 12, "overflow": 12, "creativ": 12, "alik": 12, "sharealik": 12, "same": [12, 19, 22, 23, 24, 25, 26, 27], "reus": 12, "violat": 12, "proce": 12, "caution": [12, 24], "excel": [12, 20, 24, 27], "worth": [12, 26], "read": [12, 13, 15, 16, 17, 19, 23, 24, 25, 26], "often": [13, 15, 19, 20, 21, 24, 25, 26, 27], "befor": [13, 15, 19, 21, 26], "appear": 13, "pypi": [13, 21, 24, 25, 26, 27, 28], "anaconda": [13, 26, 28], "highlight": [13, 24], "pandera": 13, "spend": [13, 24], "front": [13, 20, 21, 26, 27, 28], "high": [13, 15, 16, 20], "editor": [13, 19, 21], "chief": 13, "revis": 13, "begin": [13, 14, 19, 21, 24], "meet": [13, 18, 21], "criteria": [13, 18], "go": [13, 18, 24], "checklist": 13, "explan": [13, 15, 18], "2": [13, 14, 15, 23, 24, 25], "4": [13, 15, 16, 19], "sentenc": [13, 15, 19], "context": [13, 15], "fit": [13, 21], "broader": [13, 16, 18, 24], "librari": [13, 16, 19], "wrap": [13, 19, 21, 24], "associ": [13, 18, 24, 27], "hint": 13, "wrapper": 13, "probabl": 13, "doesn": [13, 18, 19, 22, 24, 25], "ve": [13, 18, 24], "bottom": [13, 14], "self": [13, 15, 27], "explanatori": 13, "better": [13, 18, 24, 27], "draw": 13, "attent": 13, "assur": [13, 15], "design": [13, 15], "properli": [13, 15], "ad": [13, 14, 16, 17, 19, 22, 23, 24, 26], "statu": 13, "fail": [13, 26], "toward": [13, 18], "brows": 13, "cloud": [13, 26, 28], "pass": [13, 15, 19], "doi": 13, "accept": [13, 21], "been": [13, 18, 19, 24, 25, 26, 27], "bewar": [13, 24], "overus": 13, "overload": 13, "potenti": [13, 14, 19, 24, 26, 27], "At": 13, "1": [13, 14, 15, 19, 23, 24, 25], "3": [13, 15, 18, 19, 23, 24, 25, 26], "state": [13, 16, 24], "goal": [13, 16, 21], "varieti": 13, "vari": 13, "complementari": 13, "school": [13, 16], "equival": [13, 27], "appropri": 13, "maxim": 13, "access": [13, 16, 22, 25, 26, 27], "sure": [13, 15, 19, 26], "authent": 13, "token": 13, "complex": [13, 15, 21, 24, 25, 26], "rather": [13, 14, 16, 19, 24, 26, 27], "than": [13, 14, 19, 20, 24, 26], "complic": 13, "avoid": [13, 19, 22], "sever": [13, 15, 16, 22, 24], "overwhelm": 13, "plenti": 13, "present": [13, 14, 26], "direct": [13, 16], "advanc": [13, 24], "final": [13, 22, 24, 27], "bane": 13, "sullivan": 13, "art": 13, "kira": 13, "hackergrrl": 13, "finish": 14, "second": [14, 24], "reproduc": 14, "construct": 14, "act": 14, "via": [14, 24, 27], "thumbnail": 14, "plot": 14, "script": [14, 15], "enjoi": 14, "mimic": 14, "method": [14, 16, 17], "attribut": [14, 15, 16, 17, 25, 27], "ie": [14, 15, 24], "ipynb": 14, "friendli": [14, 24], "visual": 14, "grid": 14, "execut": 14, "per": 14, "downsid": 14, "finicki": 14, "particularli": [14, 24, 25, 26], "matplotlib": 14, "name": [14, 16, 19, 22, 23, 24, 25, 26, 27], "plot_": 14, "dai": [14, 27], "slightli": [14, 15, 24, 26], "nuanc": [14, 20, 24], "successfulli": [14, 19], "directori": [14, 19, 22, 24, 25, 26], "plot_tutori": 14, "produc": 14, "build_exampl": 14, "plot_sampl": 14, "built_exampl": 14, "dir": 14, "sg_execution_tim": 14, "similarli": [14, 22, 27], "pro": 14, "con": 14, "By": [14, 15, 24, 26], "addit": [14, 15, 16, 18, 19, 20, 21, 24, 25, 27], "epilog": 14, "singl": [14, 15, 24, 27], "column": 14, "another_tutori": 14, "separ": [14, 15, 23, 24], "seri": 14, "onpythonpackag": 14, "stand": 15, "ppli": 15, "p": 15, "rogram": 15, "nterfac": 15, "add_numb": 15, "bunch": 15, "number": [15, 24, 25], "simpli": 15, "calcul": 15, "valu": [15, 23, 27], "return": [15, 19, 24, 27], "6": [15, 18, 19], "consist": [15, 19, 21, 22, 24, 25, 27], "interfac": [15, 24], "describ": [15, 16, 21, 27], "input": 15, "usual": [15, 22], "paramet": 15, "argument": [15, 24], "effect": 15, "automag": [15, 17, 19, 27], "full": [15, 18, 22, 24], "clean": [15, 18, 19, 22, 24], "along": 15, "brief": 15, "dig": 15, "down": [15, 24, 26], "click": [15, 23, 24, 26], "descript": [15, 23, 27], "reason": [15, 21, 25, 26, 27], "explain": [15, 27], "defin": [15, 16, 25], "string": [15, 19], "int": 15, "np": 15, "arrai": 15, "object": 15, "googl": 15, "rest": 15, "simplifi": [15, 27], "contrast": 15, "harder": [15, 26, 27], "scan": [15, 19], "take": [15, 19, 26], "line": [15, 19, 24, 27], "modul": [15, 19], "napoleon": 15, "good": [15, 18, 21, 27], "short": [15, 16], "longer": [15, 19, 24], "def": 15, "extent_to_json": 15, "ext_obj": 15, "convert": 15, "bound": [15, 24], "shape": [15, 18], "geojson": 15, "spatial": [15, 16], "crop": 15, "raster": 15, "imag": [15, 19], "geodatafram": 15, "extent": [15, 27], "otherwis": [15, 27], "minx": 15, "mini": 15, "maxx": 15, "maxi": 15, "extent_json": 15, "dictionari": 15, "corner": 15, "coordin": [15, 19], "repres": [15, 24], "contain": [15, 18, 22, 23, 25, 26, 27], "gpd": 15, "earthpi": 15, "e": [15, 18, 19, 20, 24, 26], "io": 15, "path_to_exampl": 15, "load": 15, "shapefil": 15, "rmnp": 15, "read_fil": 15, "shp": 15, "convers": [15, 27], "polygon": 15, "105": 15, "4935937": 15, "40": 15, "1580827": 15, "correct": [15, 20, 24], "mind": [15, 16, 24], "neither": [15, 19], "item": [15, 19, 25], "replac": [15, 23], "alon": [15, 21], "across": [15, 18, 19, 21, 22, 24, 25, 26], "system": [15, 23, 24, 25, 26, 27], "add_m": 15, "num1": 15, "num2": 15, "sum": 15, "integ": 15, "saw": [15, 19], "layer": [15, 21, 24], "anum": 15, "anum2": 15, "being": [15, 18, 21, 24], "debug": 15, "faster": [15, 25], "static": 15, "mypi": 15, "perform": [15, 21, 24], "lower": 15, "entranc": 15, "barrier": 15, "difficult": [15, 18, 20, 24], "true": 15, "multipl": [15, 19, 24, 27], "obviou": [15, 23], "sens": [15, 27], "lot": [15, 24], "increment": 15, "break": [16, 24, 27], "broadli": [16, 19, 22], "granular": 16, "showcas": 16, "greater": 16, "navig": [16, 24], "highli": 16, "audienc": 16, "whenev": 16, "jargon": 16, "instruct": 16, "reader": 16, "vignett": 16, "small": [16, 19, 26, 27], "involv": [16, 27], "part": [16, 19, 26], "store": [16, 23, 24, 25, 27], "card": 16, "popul": 17, "galleri": 17, "curat": 18, "surround": [18, 19, 24], "decis": [18, 19, 20, 27], "vision": 18, "landscap": 18, "conda": [18, 19, 21, 24, 25], "forg": [18, 19, 21], "author": [18, 19, 21, 23], "expertis": 18, "usabl": 18, "relat": [18, 19, 22], "knowledg": [18, 21, 24], "area": 18, "foundat": 18, "modern": [18, 21, 24, 27], "effici": 18, "assum": [18, 27], "guidanc": [18, 21], "friend": [18, 19], "come": [18, 24, 26], "right": [18, 21, 22], "incredibli": 18, "numer": [18, 24, 26], "domain": [18, 24], "xkcd": 18, "comic": 18, "enough": [18, 24], "bar": 18, "higher": 18, "hope": 18, "ultim": 18, "beyond": [18, 19], "now": [18, 22, 27], "invit": 18, "mayb": 18, "ci": [18, 22, 27], "too": [18, 19], "cooki": 18, "cutter": 18, "situat": 18, "yet": 18, "soon": 18, "must": 18, "alwai": [18, 19, 26, 27], "explicit": 18, "compat": [18, 24, 27], "old": 18, "thumb": 18, "least": 18, "latest": 18, "g": [18, 19, 20, 24, 26], "8": [18, 19, 24, 27], "7": 18, "consult": 18, "pep": [18, 19, 21, 24, 27], "http": [18, 19], "www": 18, "org": [18, 22, 23], "dev": [18, 19], "0008": 18, "lint": 18, "linter": [18, 21], "flake8": [18, 21], "readabl": [19, 23], "precommit": 19, "bot": [19, 27], "pr": 19, "config": 19, "save": 19, "signific": [19, 26], "without": [19, 24, 25], "space": [19, 26], "punctuat": 19, "brain": 19, "forinstanceifyousawasentencelikethisonewithoutani": 19, "benefit": [19, 24], "daili": 19, "manual": [19, 24], "consum": 19, "road": 19, "reformat": 19, "adher": [19, 24], "throughout": [19, 27], "inconsist": 19, "lengthi": 19, "person": 19, "dure": 19, "implement": [19, 21, 27], "dive": 19, "identifi": [19, 23, 24], "typic": 19, "tell": [19, 24], "stylist": 19, "doubl": 19, "quot": 19, "unapologet": 19, "except": [19, 25], "length": 19, "88": 19, "79": 19, "10": 19, "charact": 19, "overwritten": 19, "adjust": [19, 26], "comment": 19, "address": [19, 24], "compar": [19, 24], "decid": [19, 21, 22, 24], "playground": 19, "leav": [19, 24], "worri": [19, 25], "pep8": 19, "toolbox": 19, "flag": 19, "conflict": 19, "miss": [19, 24, 26], "after": [19, 27], "comma": 19, "unus": 19, "declar": 19, "variabl": [19, 27], "filenam": [19, 25], "stravalib": [19, 25], "model": 19, "usernam": 19, "comput": [19, 25], "f401": 19, "o": [19, 23], "29": 19, "80": 19, "e501": 19, "long": [19, 24, 27], "90": 19, "34": 19, "95": 19, "442": 19, "82": 19, "443": 19, "39": 19, "e231": 19, "whitespac": 19, "493": 19, "20": 19, "e225": 19, "496": 19, "group": [19, 24, 26, 27], "third": 19, "parti": 19, "reorder": 19, "think": [19, 21, 26], "exc": 19, "starvalib": 19, "abc": 19, "log": 19, "distribut": [19, 20, 22, 24], "extra": 19, "sequenc": 19, "unithelp": 19, "uh": 19, "shown": 19, "vscode": [19, 24], "pycharm": [19, 24], "shortcut": 19, "demand": 19, "action": [19, 27], "trigger": [19, 27], "m": [19, 24, 27], "messag": [19, 24, 27], "hit": 19, "NOT": [19, 24, 26], "re": [19, 21], "stage": [19, 22], "next": [19, 24], "record": [19, 25], "cancel": 19, "activ": [19, 24, 26, 27], "intend": 19, "amount": 19, "lead": [19, 22, 25], "merg": [19, 22], "trail": 19, "streamlin": [19, 24], "becom": [19, 27], "comer": 19, "never": [19, 24, 27], "c": [19, 20, 21, 22], "cofig": 19, "com": 19, "pycqa": 19, "rev": 19, "5": 19, "11": [19, 26], "id": [19, 24], "misc": 19, "v4": 19, "0": [19, 23, 24, 25, 27], "ref": 19, "autoformat": 19, "newlin": 19, "onli": [19, 20, 22, 24, 27], "fixer": 19, "insensit": 19, "filesystem": 19, "maco": 19, "hf": 19, "window": [19, 22, 25], "fat": 19, "auto": [19, 24], "psf": 19, "22": 19, "12": 19, "language_vers": 19, "python3": [19, 24], "codo": 19, "quarter": 19, "weekli": 19, "remov": [19, 24], "aren": [19, 26], "autoupdate_schedul": 19, "quarterli": 19, "readi": [19, 25], "regardless": [19, 22], "whether": [19, 26], "manag": [19, 23, 24, 25, 28], "feedback": [19, 24], "reduc": [19, 24], "effort": [19, 21, 26], "compil": [20, 24, 25, 26], "non": 20, "overview": [20, 21, 24, 26, 27], "thorough": 20, "classifi": [20, 23], "categori": 20, "back": [20, 23], "reli": [20, 24, 27], "setuptool": 20, "hatch": [20, 23], "hatchl": [20, 24], "pdm": 20, "choic": [20, 24, 27], "fortran": [20, 24], "gdal": [20, 22], "scikit": [20, 24, 26], "meson": [20, 24], "confus": [21, 24], "src": 21, "layout": 21, "flat": 21, "No": [21, 24], "matter": 21, "pure": [21, 25, 27], "straight": [21, 22], "forward": [21, 22], "channel": 21, "black": 21, "blue": 21, "ruff": 21, "why": [21, 22], "diagram": [21, 24], "bare": 21, "plan": [21, 24], "u": 21, "anyon": [21, 22, 25], "expand": 21, "align": [21, 24], "enhanc": 21, "spec": 21, "numpi": [21, 26], "program": [21, 23, 24], "lend": 21, "divers": 21, "rang": [21, 24], "abil": 21, "hear": 21, "glue": 21, "newer": [21, 24], "made": [21, 27], "intent": 21, "scope": 21, "public": 22, "bioconda": 22, "minim": [22, 23], "between": [22, 24], "prior": 22, "biggest": 22, "wherea": 22, "sdist": [22, 23, 24], "tar": [22, 25], "gz": [22, 25], "zip": [22, 25], "wheel": [22, 23, 24], "whl": [22, 24], "realli": 22, "bundl": [22, 25], "privat": 22, "origin": 22, "cross": 22, "julia": 22, "r": [22, 24], "mix": 22, "fledg": 22, "bla": 22, "lapack": 22, "hous": 22, "inc": 22, "driven": 22, "geospati": 22, "biomed": 22, "emerg": 22, "did": 22, "geohackweek": 22, "wonder": 22, "importantli": 22, "pick": [22, 24], "answer": 22, "everyth": [22, 25], "speak": 22, "smaller": [22, 24, 26], "chanc": 22, "yield": 22, "stabl": 22, "complement": 22, "anticip": 22, "terminologi": 22, "glossari": 22, "recip": 22, "grayskul": 22, "mac": [22, 25], "linux": [22, 25], "iron": 22, "feedstock": 22, "kick": 22, "off": 22, "complet": [22, 24], "notif": 22, "happi": 22, "cfg": [23, 25], "tom": 23, "kei": [23, 27], "pair": 23, "tabl": 23, "particular": 23, "human": [23, 27], "caus": 23, "problem": 23, "backend": [23, 24, 27], "examplepi": 23, "email": 23, "keyword": [23, 27], "independ": 23, "swap": 23, "setuptools_scm": [23, 24, 25], "control": [23, 24], "61": 23, "build_meta": 23, "poetri": 23, "focu": 24, "draft": 24, "truli": 24, "until": 24, "were": 24, "pypa": [24, 26], "survei": 24, "twine": 24, "beginn": [24, 26], "oppos": 24, "upper": 24, "overrid": 24, "discord": 24, "lock": 24, "matrix": 24, "clear": [24, 26], "winner": 24, "mode": 24, "stick": 24, "experi": 24, "upload": [24, 26], "testpypi": 24, "dist": [24, 25], "main": [24, 27], "much": 24, "plugin": [24, 27], "undocu": 24, "correctli": [24, 26], "result": 24, "n": 24, "000": [24, 26], "seen": [24, 26], "heavili": 24, "snapshot": 24, "ye": 24, "hook": [24, 27], "appreci": [24, 26], "summar": 24, "git": [24, 25], "bump": 24, "bu": 24, "factor": 24, "semant": [24, 26], "commit": [24, 27], "receiv": 24, "pyd": 24, "app": 24, "critic": 24, "virtual": 24, "__pypackages__": 24, "init": 24, "dynam": 24, "patch": [24, 27], "minor": [24, 27], "pyproject": [24, 25, 26], "toml": [24, 25, 26], "edit": 24, "strict": 24, "constraint": 24, "came": 24, "Its": 24, "individu": 24, "risk": 24, "gap": 24, "frill": 24, "basic": 24, "symlink": 24, "track": [24, 27], "handl": 24, "instead": 24, "unifi": 24, "makefil": [24, 25], "drop": 24, "switch": 24, "hatch_vc": [24, 25], "creation": 24, "uniqu": 24, "tox": 24, "easili": 24, "burden": [24, 26], "lack": 24, "desir": 24, "recogn": 24, "upcom": 24, "organ": 24, "problemat": 24, "quit": 24, "symbol": 24, "breakout": 24, "9": [24, 27], "x": [24, 25, 27], "calver": [24, 27], "date": [24, 27], "matur": 24, "2009": 24, "earlier": 24, "largest": 24, "accord": 24, "customiz": 24, "backward": [24, 27], "compatibli": 24, "pylanc": 24, "comparison": 24, "awar": 24, "exclud": 24, "manifest": [24, 25], "raw": 25, "onto": 25, "veri": [25, 27], "unbuilt": 25, "ourc": 25, "ribut": 25, "impli": [25, 27], "compress": 25, "network": 25, "normal": [25, 26, 27], "tarbal": 25, "post2": 25, "__init__": [25, 26], "conftest": 25, "strava_api_stub": 25, "test_client": 25, "unit": 25, "test_attribut": 25, "auth_respond": 25, "ini": 25, "util": 25, "_version": [25, 27], "_version_gener": 25, "egg": 25, "info": 25, "pkg": 25, "dependency_link": 25, "top_level": 25, "changelog": [25, 26], "yml": 25, "whose": 25, "binari": 25, "machin": 25, "pre": [25, 27], "malici": 25, "inject": 25, "py3": 25, "none": 25, "post": 25, "processor": 25, "architectur": 25, "unpack": 25, "unzip": 25, "client": 25, "advantag": 26, "tremend": 26, "proof": 26, "mypackagereponam": 26, "mypackag": 26, "modulea": 26, "moduleb": 26, "chapter": 26, "sourmash": 26, "bokeh": 26, "openscm": 26, "awkward": 26, "poliastro": 26, "against": 26, "outsid": 26, "size": 26, "storag": 26, "400": 26, "search": 26, "path": 26, "forc": 26, "prioriti": 26, "pythonsafepath": 26, "Be": 26, "pytest": 26, "accompani": 26, "larg": 26, "slow": 26, "discourag": 26, "figshar": 26, "zenodo": 26, "pooch": 26, "increas": [26, 27], "toll": 26, "deal": 26, "thousand": 26, "tend": 26, "respect": 26, "had": 26, "cost": 26, "primari": [26, 27], "characterist": 26, "file1": 26, "histor": 26, "unlik": 26, "engrain": 26, "danger": 26, "xarrai": 26, "invest": 26, "takewai": 27, "equat": 27, "hatch_vsc": 27, "flit": 27, "hand": 27, "440": 27, "assign": 27, "Being": 27, "express": 27, "deprec": 27, "polici": 27, "incompat": 27, "manner": 27, "label": 27, "One": 27, "bump2vers": 27, "determin": 27, "ex": 27, "With": 27, "truth": 27, "elimin": 27, "vc": 27, "anywher": 27, "sometim": 27, "hard": 27, "enter": 27, "Not": 27, "slower": 27, "convent": 27, "word": 27, "attribute_warn": 27, "mod_plot": 27, "warn": 27, "athlet": 27, "feat": 27, "add_convers": 27, "hasn": 27, "sinc": 27, "2020": 27, "troubleshoot": 27, "cleaner": 27, "histori": 27, "wrong": 27, "stai": 28, "tune": 28, "under": 28, "januari": 28}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"contribut": [0, 9, 13], "guid": [0, 10, 13, 18, 21], "python": [0, 4, 5, 7, 8, 9, 10, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 24, 25, 26, 27, 28], "open": [0, 7, 8, 9, 16, 18], "sourc": [0, 7, 8, 9, 16, 18, 25, 26], "softwar": 0, "packag": [0, 4, 5, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28], "book": 0, "how": [0, 4, 13, 15, 18, 19, 22, 26], "thi": [0, 7, 18, 21], "structur": [0, 21, 26], "instruct": [0, 13], "build": [0, 2, 5, 14, 20, 23, 24, 27], "document": [0, 2, 3, 4, 5, 6, 7, 11, 13, 14, 15, 16, 17], "local": [0, 19], "your": [0, 2, 3, 4, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 19, 22, 23, 26, 27], "comput": 0, "ci": [1, 19], "test": [1, 13, 26], "come": [1, 28], "soon": [1, 28], "tool": [2, 7, 19, 24, 27, 28], "host": 2, "syntax": 3, "markdown": 3, "v": [3, 4, 19, 20, 24, 25, 27], "myst": 3, "rst": 3, "creat": [3, 14, 16, 18, 27], "doc": [3, 4, 14], "publish": [4, 22], "onlin": 4, "what": [4, 7, 9, 10, 13, 15, 18, 21, 22, 26], "i": [4, 7, 10, 15, 18, 22, 23], "read": 4, "github": [4, 25], "page": [4, 16], "us": [5, 13, 14, 15, 19, 23, 24, 26, 27], "sphinx": [5, 6, 14], "static": 5, "site": 5, "gener": [5, 19], "can": [5, 22, 24, 27], "custom": 5, "extens": [5, 20, 24], "theme": 5, "commonli": 5, "optim": 6, "so": 6, "search": 6, "engin": 6, "other": [6, 20, 27], "user": [6, 7, 16, 17, 22], "find": [6, 18], "googl": 6, "analyt": 6, "sitemap": 6, "sphinxext": 6, "opengraph": 6, "critic": 7, "": [7, 13, 15, 18, 21], "success": 7, "two": 7, "type": [7, 15], "1": [7, 27], "basic": 7, "2": [7, 27], "potenti": 7, "contributor": 7, "element": [7, 16], "pyopensci": [7, 18, 21, 26], "look": [7, 26], "review": [7, 21, 24, 26], "next": 7, "section": [7, 13], "The": [8, 25, 26], "code_of_conduct": 8, "md": [8, 9, 12, 13], "file": [8, 9, 11, 12, 13, 23, 25], "In": [8, 22], "exampl": [8, 9, 15, 19, 23, 24, 26, 27], "code": [8, 13, 15, 19], "conduct": [8, 13], "why": [8, 10, 15, 24, 26], "you": [8, 12, 14, 18, 21, 22, 24, 27], "need": [8, 26], "should": [9, 10, 11, 12, 13], "contain": [9, 10, 13], "develop": [10, 18], "import": [10, 12, 26], "That": 11, "repositori": [11, 12, 22], "have": 12, "licens": 12, "make": [12, 19], "sure": 12, "close": 12, "follow": 12, "guidelin": [12, 13, 21], "outlin": 12, "chose": [12, 24], "readm": 13, "resourc": 13, "name": 13, "badg": 13, "current": 13, "version": [13, 27], "continu": 13, "integr": 13, "coverag": 13, "A": [13, 22], "short": 13, "easi": 13, "understand": 13, "descript": 13, "doe": [13, 15, 26], "instal": 13, "ani": 13, "addit": 13, "setup": [13, 23, 27], "requir": [13, 21, 26], "brief": 13, "demonstr": 13, "link": 13, "tutori": [13, 14], "too": [13, 15], "much": [13, 15], "Of": 13, "good": [13, 16], "thing": 13, "commun": [13, 22], "citat": 13, "inform": [13, 21], "run": [14, 15, 19], "when": 14, "galleri": 14, "benefit": [14, 23, 26], "challeng": [14, 24, 26], "nbsphinx": 14, "jupyt": 14, "notebook": 14, "api": 15, "docstr": 15, "an": [15, 24], "relat": 15, "three": 15, "format": [15, 19], "we": [15, 24], "like": [15, 26, 27], "numpi": 15, "style": [15, 19], "better": 15, "best": 15, "function": 15, "doctest": 15, "method": 15, "ad": 15, "hint": 15, "bewar": 15, "gradual": 15, "face": [16, 17], "core": [16, 26], "compon": 16, "write": [16, 17], "usabl": 16, "four": 16, "land": 16, "welcom": 18, "enthusiast": 18, "goal": 18, "who": 18, "guidebook": 18, "where": [18, 22], "head": 18, "linter": 19, "life": 19, "easier": 19, "lint": 19, "formatt": 19, "styler": 19, "black": 19, "blue": 19, "flake8": 19, "isort": 19, "applic": 19, "workflow": [19, 24], "favorit": 19, "pre": 19, "commit": 19, "hook": 19, "check": 19, "set": 19, "up": 19, "git": [19, 27], "summari": [19, 24], "complex": [20, 23], "pure": [20, 24], "languag": 20, "learn": [21, 24], "here": [21, 24], "recommend": 21, "suggest": [21, 24], "ar": [21, 26], "pypi": 22, "anaconda": 22, "cloud": 22, "conda": 22, "channel": 22, "pip": 22, "manag": [22, 27], "depend": [22, 24], "conflict": 22, "take": 22, "awai": 22, "If": 22, "both": 22, "forg": 22, "accommod": 22, "more": [22, 24], "submit": 22, "maintain": 22, "pyproject": [23, 27], "toml": [23, 27], "configur": 23, "metadata": 23, "py": 23, "still": 23, "pdm": [23, 24, 27], "setuptool": [23, 24, 27], "hatch": [24, 27], "poetri": 24, "front": 24, "end": [24, 27], "back": [24, 27], "step": 24, "simplifi": 24, "choos": 24, "support": 24, "non": 24, "ecosystem": 24, "do": [24, 26], "featur": 24, "tabl": 24, "c": 24, "flit": 24, "about": [24, 26], "might": 24, "want": 24, "pin": 24, "wheel": [25, 26], "distribut": [25, 26], "sdist": 25, "archiv": 25, "whl": 25, "scientif": 26, "project": 26, "never": 26, "specif": 26, "peer": 26, "src": 26, "layout": 26, "discov": 26, "priorit": 26, "modul": 26, "sometim": 26, "includ": 26, "data": 26, "don": 26, "t": 26, "suit": 26, "dataset": 26, "flat": 26, "most": 26, "new": 27, "semver": 27, "rule": 27, "avoid": 27, "manual": 27, "updat": 27, "number": 27, "semant": 27, "releas": 27, "control": 27, "base": 27, "bump": 27, "offer": 27, "increment": 27, "pro": 27, "con": 27, "hatch_vc": 27, "hatchl": 27, "3": 27, "scm": 27, "tag": 27, "setuptools_scm": 27, "4": 27}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"Contributing Guide for the Python open source software packaging book": [[0, "contributing-guide-for-the-python-open-source-software-packaging-book"]], "How this guide structured": [[0, "how-this-guide-structured"]], "Instructions for building the documentation locally on your computer": [[0, "instructions-for-building-the-documentation-locally-on-your-computer"]], "CI and Testing - Coming Soon!": [[1, "ci-and-testing-coming-soon"]], "Tools to Build and Host your Documentation": [[2, "tools-to-build-and-host-your-documentation"]], "Documentation syntax: markdown vs. myST vs. rst syntax to create your docs": [[3, "documentation-syntax-markdown-vs-myst-vs-rst-syntax-to-create-your-docs"]], "How to publish your Python package documentation online": [[4, "how-to-publish-your-python-package-documentation-online"]], "What is Read the Docs ?": [[4, "what-is-read-the-docs"]], "What is GitHub Pages?": [[4, "what-is-github-pages"]], "Read the Docs vs GitHub Pages": [[4, "read-the-docs-vs-github-pages"]], "Using Sphinx to Build Python Package Documentation": [[5, "using-sphinx-to-build-python-package-documentation"]], "Sphinx - a static site generator": [[5, "sphinx-a-static-site-generator"]], "Sphinx sites can be customized using extensions and themes": [[5, "sphinx-sites-can-be-customized-using-extensions-and-themes"]], "Commonly used Sphinx themes": [[5, "commonly-used-sphinx-themes"]], "Optimizing your documentation so search engines (and other users) find it": [[6, "optimizing-your-documentation-so-search-engines-and-other-users-find-it"]], "Google Analytics": [[6, "google-analytics"]], "sphinx-sitemap for search engine optimization": [[6, "sphinx-sitemap-for-search-engine-optimization"]], "sphinxext.opengraph": [[6, "sphinxext-opengraph"]], "Documentation for your Open Source Python Package": [[7, "documentation-for-your-open-source-python-package"]], "Documentation is critical for your Python package\u2019s success": [[7, "documentation-is-critical-for-your-python-package-s-success"]], "Two types of Python package users": [[7, "two-types-of-python-package-users"]], "1. Basic Tool Users": [[7, "basic-tool-users"]], "2. Potential tool contributors": [[7, "potential-tool-contributors"]], "Documentation elements that pyOpenSci looks for reviewing a Python package": [[7, "documentation-elements-that-pyopensci-looks-for-reviewing-a-python-package"]], "What\u2019s next in this Python package documentation section?": [[7, "what-s-next-in-this-python-package-documentation-section"]], "The CODE_OF_CONDUCT.md file In Your Python Open Source Package": [[8, "the-code-of-conduct-md-file-in-your-python-open-source-package"]], "Example Code of Conduct files": [[8, null]], "Why you need a code of conduct": [[8, "why-you-need-a-code-of-conduct"]], "Contributing File in your Python Open Source Package": [[9, "contributing-file-in-your-python-open-source-package"]], "What a CONTRIBUTING.md file should contain": [[9, "what-a-contributing-md-file-should-contain"]], "Example contributing files": [[9, null]], "What the development guide for your Python package should contain": [[10, "what-the-development-guide-for-your-python-package-should-contain"]], "Why a development guide is important": [[10, "why-a-development-guide-is-important"]], "Documentation Files That Should be in your Python Package Repository": [[11, "documentation-files-that-should-be-in-your-python-package-repository"]], "Your repository should have a LICENSE.md file": [[12, "your-repository-should-have-a-license-md-file"]], "Important: make sure that you closely follow the guidelines outlines by the License that you chose": [[12, "important-make-sure-that-you-closely-follow-the-guidelines-outlines-by-the-license-that-you-chose"]], "README File Guidelines and Resources": [[13, "readme-file-guidelines-and-resources"]], "What your README.md file should contain": [[13, "what-your-readme-md-file-should-contain"]], "\u2714\ufe0f Your package\u2019s name": [[13, "your-package-s-name"]], "\u2714\ufe0f Badges for current package version, continuous integration and test coverage": [[13, "badges-for-current-package-version-continuous-integration-and-test-coverage"]], "\u2714\ufe0f A short, easy-to-understand description of what your package does": [[13, "a-short-easy-to-understand-description-of-what-your-package-does"]], "\u2714\ufe0f Installation instructions": [[13, "installation-instructions"]], "\u2714\ufe0f Document any additional setup required": [[13, "document-any-additional-setup-required"]], "\u2714\ufe0f Brief demonstration of how to use the package": [[13, "brief-demonstration-of-how-to-use-the-package"]], "\u2714\ufe0f Descriptive links to package documentation, short tutorials": [[13, "descriptive-links-to-package-documentation-short-tutorials"]], "Too Much Of A Good Thing": [[13, null]], "\u2714\ufe0f A Community Section with Links to Contributing Guide, Code of Conduct": [[13, "a-community-section-with-links-to-contributing-guide-code-of-conduct"]], "\u2714\ufe0f Citation information": [[13, "citation-information"]], "Create tutorials in your Python package documentation": [[14, "create-tutorials-in-your-python-package-documentation"]], "Create Python package tutorials that run when you build your docs": [[14, "create-python-package-tutorials-that-run-when-you-build-your-docs"]], "sphinx gallery:": [[14, "sphinx-gallery"]], "Sphinx Gallery benefits": [[14, "sphinx-gallery-benefits"]], "Sphinx gallery challenges": [[14, "sphinx-gallery-challenges"]], "nbsphinx - tutorials using Jupyter Notebooks": [[14, "nbsphinx-tutorials-using-jupyter-notebooks"]], "Document the code in your package\u2019s API using docstrings": [[15, "document-the-code-in-your-package-s-api-using-docstrings"]], "What is an API?": [[15, "what-is-an-api"]], "What is a docstring and how does it relate to documentation?": [[15, "what-is-a-docstring-and-how-does-it-relate-to-documentation"]], "Python package API documentation": [[15, "python-package-api-documentation"]], "Three Python docstring formats and why we like NumPy style": [[15, "three-python-docstring-formats-and-why-we-like-numpy-style"]], "Docstring examples Better and Best": [[15, "docstring-examples-better-and-best"]], "Best: a docstring with example use of the function": [[15, "best-a-docstring-with-example-use-of-the-function"]], "Using doctest to run docstring examples in your package\u2019s methods and functions": [[15, "using-doctest-to-run-docstring-examples-in-your-package-s-methods-and-functions"]], "Adding type hints to your docstrings": [[15, "adding-type-hints-to-your-docstrings"]], "Why use type hints": [[15, "why-use-type-hints"]], "Beware of too much type hinting": [[15, null]], "Gradually adding type hints": [[15, "gradually-adding-type-hints"]], "Create User Facing Documentation for your Python Package": [[16, "create-user-facing-documentation-for-your-python-package"]], "Core components of user-facing Python package documentation": [[16, "core-components-of-user-facing-python-package-documentation"]], "Write usable documentation": [[16, "write-usable-documentation"]], "Four elements of a good open source documentation landing page": [[16, "four-elements-of-a-good-open-source-documentation-landing-page"]], "Writing user-facing documentation for your Python package": [[17, "writing-user-facing-documentation-for-your-python-package"]], "pyOpenSci Python Open Source Package Development Guide": [[18, "pyopensci-python-open-source-package-development-guide"]], "Welcome, Python open source enthusiast!": [[18, "welcome-python-open-source-enthusiast"]], "pyOpenSci\u2019s packaging goals": [[18, "pyopensci-s-packaging-goals"]], "How this guide is created": [[18, "how-this-guide-is-created"]], "Who this guidebook is for": [[18, "who-this-guidebook-is-for"]], "What you will find in this guidebook": [[18, "what-you-will-find-in-this-guidebook"]], "Where this guide is headed": [[18, "where-this-guide-is-headed"]], "Python Package Code Style, Format and Linters": [[19, "python-package-code-style-format-and-linters"]], "Use a code format tool (or tools) to make your life easier": [[19, "use-a-code-format-tool-or-tools-to-make-your-life-easier"]], "Linting vs format and style": [[19, "linting-vs-format-and-style"]], "Code Linting": [[19, "code-linting"]], "Code Formatters (and stylers)": [[19, "code-formatters-and-stylers"]], "Code format and style": [[19, "code-format-and-style"]], "Black and Blue": [[19, "black-and-blue"]], "flake8 for linting code in Python packages": [[19, "flake8-for-linting-code-in-python-packages"]], "Isort": [[19, "isort"]], "Example application of isort": [[19, "example-application-of-isort"]], "How to use code formatter in your local workflow": [[19, "how-to-use-code-formatter-in-your-local-workflow"]], "Linters, code formatters and your favorite coding tools": [[19, "linters-code-formatters-and-your-favorite-coding-tools"]], "Use pre-commit hooks to run code formatters and linters on commits": [[19, "use-pre-commit-hooks-to-run-code-formatters-and-linters-on-commits"]], "Pre-commit hook example workflow": [[19, "pre-commit-hook-example-workflow"]], "General pre commit checks": [[19, "general-pre-commit-checks"]], "Pre-commit.ci": [[19, "pre-commit-ci"]], "Setting up a git pre-commit hook": [[19, "setting-up-a-git-pre-commit-hook"]], "Summary": [[19, "summary"]], "Complex Python package builds": [[20, "complex-python-package-builds"]], "Pure Python Packages vs. packages with extensions in other languages": [[20, "pure-python-packages-vs-packages-with-extensions-in-other-languages"]], "Python package structure information": [[21, "python-package-structure-information"]], "What you will learn here": [[21, "what-you-will-learn-here"]], "Guidelines for pyOpenSci\u2019s packaging recommendations": [[21, "guidelines-for-pyopensci-s-packaging-recommendations"]], "Suggestions in this guide are not pyOpenSci review requirements": [[21, null]], "Publishing Your Package In A Community Repository: PyPI or Anaconda Cloud": [[22, "publishing-your-package-in-a-community-repository-pypi-or-anaconda-cloud"]], "What is PyPI": [[22, "what-is-pypi"]], "What is Anaconda Cloud and Conda?": [[22, "what-is-anaconda-cloud-and-conda"]], "Conda channels": [[22, "conda-channels"]], "Conda channels, PyPI, conda, pip - Where to publish your package": [[22, "conda-channels-pypi-conda-pip-where-to-publish-your-package"]], "Managing Python package dependency conflicts": [[22, "managing-python-package-dependency-conflicts"]], "Take-aways: If you can, publish on both PyPI and conda-forge to accommodate more users of your package": [[22, "take-aways-if-you-can-publish-on-both-pypi-and-conda-forge-to-accommodate-more-users-of-your-package"]], "How to submit to conda-forge": [[22, "how-to-submit-to-conda-forge"]], "Maintaining your conda-forge package repository": [[22, "maintaining-your-conda-forge-package-repository"]], "Use a pyproject.toml file for your package configuration & metadata": [[23, "use-a-pyproject-toml-file-for-your-package-configuration-metadata"]], "Benefits of using a pyproject.toml file": [[23, "benefits-of-using-a-pyproject-toml-file"]], "Setup.py is still useful for complex package builds": [[23, null]], "Example pyproject.toml for building using PDM": [[23, "example-pyproject-toml-for-building-using-pdm"]], "Example pyproject.toml for building using setuptools": [[23, "example-pyproject-toml-for-building-using-setuptools"]], "Python Package Build Tools": [[24, "python-package-build-tools"]], "Tools that we review here": [[24, "tools-that-we-review-here"]], "Summary of tools Hatch vs. PDM vs. Poetry (and setuptools)": [[24, "summary-of-tools-hatch-vs-pdm-vs-poetry-and-setuptools"]], "Build front-end vs. build back-end tools": [[24, "build-front-end-vs-build-back-end-tools"]], "Build back-ends": [[24, "build-back-ends"]], "Python package build front-ends": [[24, "python-package-build-front-ends"]], "Example build steps that can be simplified using a front-end tool": [[24, "example-build-steps-that-can-be-simplified-using-a-front-end-tool"]], "Choosing a build back-end": [[24, "choosing-a-build-back-end"]], "Build back-end support for non pure-python packages": [[24, "build-back-end-support-for-non-pure-python-packages"]], "An ecosystem of Python build tools": [[24, "an-ecosystem-of-python-build-tools"]], "We do not suggest using setuptools": [[24, null]], "Chose a build workflow tool": [[24, "chose-a-build-workflow-tool"]], "Python packaging tools summary": [[24, "python-packaging-tools-summary"]], "Package tool features table": [[24, "package-tool-features-table"]], "PDM": [[24, "pdm"]], "PDM support for C and C++ extensions": [[24, null]], "PDM Features": [[24, "pdm-features"]], "PDM vs. Poetry": [[24, null]], "Challenges with PDM": [[24, "challenges-with-pdm"]], "Flit": [[24, "flit"]], "Flit Features": [[24, "flit-features"]], "Learn more about flit": [[24, null]], "Why you might not want to use Flit": [[24, "why-you-might-not-want-to-use-flit"]], "Hatch": [[24, "hatch"]], "Hatch features": [[24, "hatch-features"]], "Why you might not want to use Hatch": [[24, "why-you-might-not-want-to-use-hatch"]], "Poetry": [[24, "poetry"]], "Poetry features": [[24, "poetry-features"]], "Challenges with Poetry": [[24, "challenges-with-poetry"]], "Challenges with Poetry dependency pinning": [[24, null]], "Using Setuptools Back-end for Python Packaging with Build Front-end": [[24, "using-setuptools-back-end-for-python-packaging-with-build-front-end"]], "Setuptools Features": [[24, "setuptools-features"]], "Challenges using setuptools": [[24, "challenges-using-setuptools"]], "The Python Package Source and Wheel Distributions": [[25, "the-python-package-source-and-wheel-distributions"]], "Source Distribution (sdist)": [[25, "source-distribution-sdist"]], "GitHub archive vs SDist": [[25, null]], "Wheel (.whl files):": [[25, "wheel-whl-files"]], "Python Package Structure for Scientific Python Projects": [[26, "python-package-structure-for-scientific-python-projects"]], "pyOpenSci will never require a specific package structure for peer review": [[26, null]], "Example scientific packages that use src/package layout": [[26, null]], "The src/ layout and testing": [[26, "the-src-layout-and-testing"]], "How Python discovers and prioritizes importing modules": [[26, null]], "Sometimes tests are needed in a distribution": [[26, "sometimes-tests-are-needed-in-a-distribution"]], "Challenges with including tests and data in a package wheel": [[26, null]], "Don\u2019t include test suite datasets in your package": [[26, "don-t-include-test-suite-datasets-in-your-package"]], "About the flat Python package layout": [[26, "about-the-flat-python-package-layout"]], "Why most scientific Python packages do not use source": [[26, null]], "What does the flat layout structure look like?": [[26, "what-does-the-flat-layout-structure-look-like"]], "Benefits of using the flat layout in your Python package": [[26, "benefits-of-using-the-flat-layout-in-your-python-package"]], "Core scientific Python packages that use the flat layout": [[26, null]], "Creating New Versions of Your Python Package": [[27, "creating-new-versions-of-your-python-package"]], "SemVer rules": [[27, "semver-rules"]], "Avoid manually updating Python package version numbers if you can": [[27, "avoid-manually-updating-python-package-version-numbers-if-you-can"]], "Tools to manage versions for your Python package": [[27, "tools-to-manage-versions-for-your-python-package"]], "Semantic release, vs version control based vs manual version bumping": [[27, "semantic-release-vs-version-control-based-vs-manual-version-bumping"]], "Tools for bumping Python package versions": [[27, "tools-for-bumping-python-package-versions"]], "Tool 1: Hatch and other build tools that offer incremental versioning": [[27, "tool-1-hatch-and-other-build-tools-that-offer-incremental-versioning"]], "Hatch (or other tools like PDM) Pros": [[27, "hatch-or-other-tools-like-pdm-pros"]], "Hatch (or other tools like PDM) Cons": [[27, "hatch-or-other-tools-like-pdm-cons"]], "Tool 2: Hatch_vcs & hatchling build back-end": [[27, "tool-2-hatch-vcs-hatchling-build-back-end"]], "Hatch example setup in your pyproject.toml": [[27, "hatch-example-setup-in-your-pyproject-toml"]], "hatch_vcs Pros": [[27, "hatch-vcs-pros"]], "hatch_vcs Cons": [[27, "hatch-vcs-cons"]], "Tool 3: setuptools-scm versioning using git tags": [[27, "tool-3-setuptools-scm-versioning-using-git-tags"]], "setuptools_scm Cons": [[27, "setuptools-scm-cons"]], "Tool 4: Python semantic release": [[27, "tool-4-python-semantic-release"]], "Python Semantic Release Pros": [[27, "python-semantic-release-pros"]], "Python Semantic Release Cons": [[27, "python-semantic-release-cons"]], "Python Packaging Tools\u2026 Coming soon\u2026": [[28, "python-packaging-tools-coming-soon"]]}, "indexentries": {}}) \ No newline at end of file