@@ -46,12 +46,17 @@ pre-commit install --install-hooks
4646
4747With ` tasks.py `
4848
49+ Note that there will be draft release on Github ...
50+ Once you release there things will be uploaded to pypi
51+ No need to do below stuffs as Github Actions ill handle it :)
52+
4953``` bat
5054git commit -m "update to next alpha"
5155git push
5256poetry run invoke bump --alpha
5357```
5458
59+ ## In case you want to publish from local machine -- IGNORE
5560
5661Note that you need to store pypi creds in poetry config and then you can publish
5762
@@ -65,7 +70,9 @@ poetry cache clear -all .
6570poetry update
6671```
6772
68- ## Getting started with ppw
73+ ## EXTRAS
74+
75+ ### Getting started with ppw
6976
7077+ use ppw to start with
7178+ use invoke instead of fire
@@ -85,33 +92,33 @@ Then ...
8592 + MDX components
8693 + multi-platform doc i.e. for mobile, desktop etc ...
8794
88- ## Documentations
95+ ### Documentations
8996
90- ### Docusauraus
97+ #### Docusauraus
9198Docusauraus will be great
9299Discussion to get sphinx inside it are going on
93100https://github.com/facebook/docusaurus/issues/1059
94101
95- ### mkdocs
102+ #### mkdocs
96103https://www.mkdocs.org
97104Not sure but thsi soes not have stuff for Docausaurus
98- ### pydoc=markdown
105+ #### pydoc=markdown
99106[ pydoc-markdown] ( https://niklasrosenstein.github.io/pydoc-markdown/api/pydoc_markdown/renderers/docusaurus/ ) has docausaurus renderer
100107
101108but I assume this one is completely different as it does not use sphinx instead has its own markdowm
102109
103- ## Badges
110+ ### Badges
104111
105112+ You can generate badges and display status
106113 + https://shields.io/category/coverage
107114
108115+ Add badges for social networking too ...
109116
110- ## LOGO Icons Images
117+ ### LOGO Icons Images
111118
112119+ https://fontmeme.com/minecraft-font
113120
114- ## Gen inspirations for different files from
121+ ### Gen inspirations for different files from
115122
116123[ pyproject.toml] ( https://github.com/python-poetry/poetry-core/blob/master/pyproject.toml )
117124
@@ -120,7 +127,7 @@ but I assume this one is completely different as it does not use sphinx instead
120127[ workflows] ( https://github.com/python-poetry/poetry-core/tree/master/.github/workflows )
121128
122129
123- ## CLI for toolcraft using ` cleo `
130+ ### CLI for toolcraft using ` cleo `
124131
125132+ tasks
126133 + Note the ` tasks.py ` is for toolcraft management may be not needed.
@@ -132,13 +139,13 @@ but I assume this one is completely different as it does not use sphinx instead
132139 + But anyways get inspiration from poetry library
133140 + https://github.com/python-poetry/poetry/tree/master/poetry/console/commands
134141
135- ## Understand ` tox ` and ` tox-gh-actions `
142+ ### Understand ` tox ` and ` tox-gh-actions `
136143
137144Refer
138145+ https://github.com/ymyzk/tox-gh-actions
139146
140147
141- ## Security (check dependencies and check python code)
148+ ### Security (check dependencies and check python code)
142149
143150Three options for dependencies:
144151+ snyk
@@ -155,25 +162,25 @@ Currently pyup it expects requirements file ... need to see how and when they wi
155162
156163Snyk seems to support poetry but the badge link does not work ... need to see that
157164
158- ### Add workflow for security
165+ #### Add workflow for security
159166
160167Make sure that before release the vulnerabilities are addressed in workflow
161168Either use
162169+ github dependabot
163170+ snyk
164171+ or something else
165172
166- ## Add to conda-forge
173+ ### Add to conda-forge
167174Example repo https://github.com/pytest-dev/pytest
168175
169176
170- ## Pre-commit
177+ ### Pre-commit
171178
172179Currently, we let pre-commit serves handle it
173180But if it fails our workflows will not know that
174181So we can make our own ` pre-commit ` workflow ... this also make it dependent on release tags
175182
176- ## Coverage
183+ ### Coverage
177184
178185There are two options
179186+ codecov
@@ -189,23 +196,23 @@ You can see branches here
189196https://app.codecov.io/gh/SpikingNeurons/toolcraft/branches?page=1&order=-updatestamp
190197
191198
192- ## Release tag specific readme badge
199+ ### Release tag specific readme badge
193200
194201We might need to have badges specific to release tage
195202And the badges that cannot be release-tag specific must be removed from readme...
196203
197204
198- ## Having workflows as dependency
205+ ### Having workflows as dependency
199206
200207https://github.com/KarmaComputing/Github-Trigger-workflow-from-another-workflow/tree/main/.github/workflows
201208
202209
203- ## Netlify
210+ ### Netlify
204211
205212We will use this as [ facebook] ( https://github.com/facebook/docusaurus/edit/main/README.md ) uses it
206213
207214
208- ### Cloud functions
215+ #### Cloud functions
209216
210217Netlify allows deploying cloud functions
211218We have set that to ` website/functions ` dir
0 commit comments