spacecow99 / pyproject-package Goto Github PK
View Code? Open in Web Editor NEWCookiecutter template for a Python3 package using pyproject.toml
License: Other
Cookiecutter template for a Python3 package using pyproject.toml
License: Other
Test example has no connection with any code. Improvement suggestion: add something as simple as a trivial function like
def sum(a, b):
return a + b
to the package. Add a test that uses said code to tests/test_sample.py
Add support for a default python3 devcontainer.json for VSCode, potentially with additional scripts.
Currently the Installation
section within our generated README.md uses pip to install, we should be using flit.
Currently the [project].readme points to the old README.rst
which breaks builds and installs. This needs to be updated to point to the new markdown file.
Move the default sphinx docs/
folder over from the default template to that supported by Read the Docs.
Add py310 to tox envlist.
Considering our primary document hosting sources (Github
, Github Pages
and ReadTheDocs
) all support Markdown in some shape or form, it is worth migrating our default sphinx documents over to Markdown by default and using the MyST package.
index.rst
in to markdownmyst-parser
as a docs dependency in pyproject.toml
myst-parser
and exclude .venv
in conf.py
A verbose README.rst document, like that of cookiecutter-pypackage-minimal, should be created before repository goes public.
The skeleton README file in the cookiecutter should be converted to markdown once issue #3 is completed. This will ensure consistency across explicit documentation (outside of docstrings) and allow it to be easily referenced in sphinx docs using myst-parser
.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.