Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add: package versionioning, pypi / conda publishing & code format pre-commit pages (Reviews Welcome!) #27

Merged
merged 35 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
25383f9
Add: package versions and publishing pages
lwasser Jan 5, 2023
16e1c24
Add: code format and linting file to package guide
lwasser Jan 6, 2023
1d5e365
Fix: review edits from Filipe
lwasser Jan 9, 2023
28f91e5
Fix: Address comments left by @ocefpaf
lwasser Jan 9, 2023
f0b1b06
Update package-structure-code/publish-python-package-pypi-conda.md
lwasser Apr 12, 2023
7982480
Update package-structure-code/publish-python-package-pypi-conda.md
lwasser Apr 12, 2023
74b1cfe
Update package-structure-code/publish-python-package-pypi-conda.md
lwasser Apr 12, 2023
feefccd
Update package-structure-code/publish-python-package-pypi-conda.md
lwasser Apr 12, 2023
8d60e2a
Update package-structure-code/publish-python-package-pypi-conda.md
lwasser Apr 12, 2023
75dcf95
Update package-structure-code/python-package-versions.md
lwasser Apr 12, 2023
3d77792
Update package-structure-code/python-package-versions.md
lwasser Apr 12, 2023
7220eac
Add: fixes to conda chapter given review
lwasser Apr 12, 2023
60bee03
docs: update README.md [skip ci]
allcontributors[bot] Apr 12, 2023
b557366
docs: update .all-contributorsrc [skip ci]
allcontributors[bot] Apr 12, 2023
697ff86
Add: update logo and decision tree diagram
lwasser Apr 18, 2023
6318a96
docs: add ucodery as a contributor for code, and review (#84)
allcontributors[bot] May 16, 2023
260369e
some user-documentation improvements
ucodery Apr 24, 2023
6fd615f
some packaging improvements
ucodery Apr 25, 2023
c838451
Remove rejected PEP-582 mentions
ucodery May 23, 2023
18fa300
Update package-structure-code/python-package-build-tools.md
lwasser May 26, 2023
1f9baa9
Update package-structure-code/python-package-build-tools.md
lwasser May 26, 2023
c2959e4
docs: add abravalheri as a contributor for code, and design (#86)
allcontributors[bot] Jun 13, 2023
a9ca983
docs: add dpprdan as a contributor for code, and review (#87)
allcontributors[bot] Jun 13, 2023
28e268f
fix: typo
dpprdan May 31, 2023
67d6b56
fix: another typo
dpprdan May 31, 2023
8887092
Fix: link to peer review in header and update diagram
lwasser Jun 16, 2023
7d4f8bb
[pre-commit.ci] pre-commit autoupdate (#89)
pre-commit-ci[bot] Jul 6, 2023
f2eba53
docs: add yang-ruoxi as a contributor for code, and review (#92)
allcontributors[bot] Jul 15, 2023
3af6ec2
Update conf.py
yang-ruoxi Jul 15, 2023
5b71584
New side bar
lwasser Jul 26, 2023
67a703d
A few small edits
lwasser Jul 26, 2023
668d919
Update landing page
lwasser Jul 26, 2023
deb0001
a few more comments that i had missed
lwasser Jul 26, 2023
597dbbf
spell check
lwasser Jul 26, 2023
ef475bf
Minor edits
lwasser Jul 26, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added images/conda-channels-geohackweek.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/precommit-hook-python-code.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/python-dependency-conflicts-xkcd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/python-flying-xkcd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
67 changes: 67 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,13 @@ We assume that you are here because you are:

Well, friend, you've come to the right place!

:::{figure-md} fig-target

<img src="/images/python-flying-xkcd.png" alt="xkcd comic showing a stick figure on the ground and one in the air. The one on the ground is saying. `You're flying! how?` The person in the air replies `Python!` Below is a 3 rectangle comic with the following text in each box. box 1 - I learned it last night. Everything is so simple. Hello world is just print hello world. box 2 - the person on the ground says - come join us programming is fun again. it's a whole new world. But how are you flying? box 3 - the person flying says - i just typed import antigravity. I also sampled everything in the medicine cabinet. But i think this is the python. the person on the ground is saying - that's it?" width="400px">

Many love to use Python because it is a clean language to learn. It also is incredibly flexible allowing it to be used across numerous domains. Source: xkcd comics.
:::

## What you will find in this guidebook

This guidebook contains:
Expand All @@ -125,3 +132,63 @@ Good meets the requirements. Going beyond the minimum can make package maintenan

This guide is now a work in progress. If you have ideas of things you'd like
to see here, [we invite you to open an issue on GitHub that details any changes or additions that you'd like to see.](https://github.com/pyOpenSci/python-package-guide/issues).

```{toctree}
:hidden:
:caption: Documentation

Documentation Overview <documentation/index>
Write User Documentation <documentation/write-user-documentation/intro>
Core GitHub Repository Files <documentation/repository-files/intro>
Documentation Tools & Hosting <documentation/hosting-tools/intro>
```

```{toctree}
:hidden:
:caption: Package structure & code style

Manage Package Versions <package-structure-code/python-package-versions>
Publish Package PyPI Conda <package-structure-code/publish-python-package-pypi-conda>
Code Style & Format <package-structure-code/code-style-linting-format>
Intro <python-packaging/intro>

```

```{toctree}
:hidden:
:caption: CI and Testing

Intro <ci-and-testing/intro>
```

<!--
COMMENTED OUT TEXT TO BE MOVED


# TODO LINK TO CI BUILDS FOR Documentation>
Maybe we can curate a list of CI builds that people can use??? or is that moving too close to a cookie cutter situation

The text below is being moved to the packaging infrastructure section which
doesn't exist YET... but will soon .
pyOpenSci packages must:

- Contain full documentation for any user-facing functions.
- Have a test suite that covers the major functionality of the package.
- Use continuous integration.
- Use an OSI approved software license.


## Other recommendations
### Python version support
You should always be explicit about which versions of Python your package supports.
Keeping compatibility with old Python versions can be difficult as functionality changes.
A good rule of thumb is that the package should support, at least,
the latest three Python versions (e.g., 3.8, 3.7, 3.6).

### Code Style
pyOpenSci encourages authors to consult [PEP 8](https://www.python.org/dev/peps/pep-0008/) for information on how to style your code.

### Linting
An automatic linter (e.g. flake8) can help ensure your code is clean and free of syntax errors. These can be integrated with your CI.

-->
Loading