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

Enh: add initial tutorial drafts #115

Closed
wants to merge 0 commits into from

Conversation

lwasser
Copy link
Member

@lwasser lwasser commented Nov 13, 2023

This is the first stab at a tutorial series. it starts with a user who wants to make their code installable.

Tutorials

  • pregame: setup dev envt (and install python??)

Packaging - drafts included in this pr.

  • what is a package
  • make your code installable
  • add a license and readme file
  • (new) prepare for pypi publication - pyproject.toml
  • publish to pypi

Extras

  • migrating from setup.py --> pyproject.toml (ADD: this can be done using hatch)

TODOS

  • styles are only applying to certain pages - revisit how they are defined...

@lwasser
Copy link
Member Author

lwasser commented Nov 16, 2023

@all-contributors please add @kcranston for code, review

Copy link
Contributor

@lwasser

I've put up a pull request to add @kcranston! 🎉

@@ -0,0 +1,485 @@
# Make your Python code pip installable

The first step in creating a Python package based on code that you
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The first step in creating a Python package based on code that you
The first step in creating a R package based on code that we

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant