Overview

This is just an idea: make this a cookiecutter template: https://cookiecutter.readthedocs.io/en/1.7.2/

I discovered this today when looking into pytest plugins.

Basically, this will fill in all the boilerplate parts of the template via user input and the cookiecutter cli

Specification

$ pip install cookiecutter
$ cookiecutter https://github.com/ApeWorX/project-template

full_name [Raphael Pierzina]: Andreas Pelme
email [[email protected]]: [email protected]
github_username [hackebrot]: pelme
plugin_name [foobar]: awesome
module_name [awesome]: awesome
short_description [A simple plugin to use with pytest]:
version [0.1.0]:
pytest_version [2.9.1]:
Select docs_tool:
1 - mkdocs
2 - sphinx
3 - none
Choose from 1, 2, 3 [1]: 1
Select license:
1 - MIT
2 - BSD-3
3 - GNU GPL v3.0
Choose from 1, 2, 3 [1]: 2
INFO:post_gen_project:Moving files for mkdocs

(copied from https://github.com/pytest-dev/cookiecutter-pytest-plugin, ours might be a little different)

Dependencies

https://cookiecutter.readthedocs.io/en/1.7.2/

This tool leverages conventional commits to generate the next release's release notes as a draft release, which can be edited before publishing it!

https://github.com/marketplace/actions/release-drafter

• change copyright in template to 2022
• look for projects started in 2022 and update these as well

Really interesting set up using RTD-style themes for statically-built docs, served using GitHub Pages (which can be routed from our main apeworx.github.io GitHub pages site, or sub-domained via docs.apeworx.io):
https://github.com/maltfield/rtd-github-pages

route to our ApeWorX discord instead

• update template to state this
• update all projects generated from the template

Overview

If you just stumble upon an ape plugin repo, it does not make a lot of sense. Especially one named ape-ledger, that almost sounds like a whole blockchain itself or something.

Perhaps we should have a big blurb at the top of each README saying "YO, THIS IS A PLUGIN FOR THIS OTHER PYTHON PACKAGE".

Specification

Something like

This package is a plugin for the [eth](link) python Ethereum framework. To use this plugin, you have to have ape installed. please and thank you.

Dependencies

Include links to any open issues that must be resolved before this feature can be implemented.

Overview

project template sounds like something ape-template does.
This is really the plugin template.

Specification

Rename repo, but will suck the life out of everyone.

Dependencies

Include links to any open issues that must be resolved before this feature can be implemented.

Environment information

Certain Libraries (e.g. IPython, dataclassy) do not have full support for Python 3.6.

https://github.com/adrienverge/yamllint

https://github.com/pypa/gh-action-pypi-publish#trusted-publishing