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

[YouTube] How to manage package #5

Open
swyo opened this issue Nov 13, 2021 · 0 comments
Open

[YouTube] How to manage package #5

swyo opened this issue Nov 13, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@swyo
Copy link
Owner

swyo commented Nov 13, 2021

I will show you how to create this repository. Apply this flow for other packages later 😄 .

Continuous Integration

GItHub Action is a good tool. You can set up workflows to check anything in code merge situations.

See this forked repo: hello-github-actions

TODO: Create workflow as yaml configuration
e.g., python-pacakage-conda workflow

This is the example: python-package-conda.yml

Advanced. create directory of Dockerfile, and action yaml file. [Not Covered in this description]

Documentation

Sphinx automatically generates code documentation for your package.

See this private repo: tools.study.sphinx

Note that *.rst files serves documentation. sphinx is a tool to serve the *.rst files.

Deployment

The setuptools library allows you to distribute the library as an open source package.

See this private repo: tools.study.python.packaging

This is the example: setup.py

@swyo swyo added the documentation Improvements or additions to documentation label Nov 13, 2021
@swyo swyo self-assigned this Nov 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant