search

ZK-Plus / ZnaKes

Crypto application code for the zkSNARKs toolbox ZoKrates
GNU Lesser General Public License v3.0
0 stars 1 forks source link

publish ZnaKes package to pip #8

Closed alv-around closed 8 months ago

alv-around commented 10 months ago

This ticket has to broken down in two phases. As the changes involved actions to the github workflow the first phase should be merge and test before proceeding to the second phase. The two phases are:

  1. Set up the github repo for a comprehensive documentation place and place where all interactions are managed. For this following actions are needed:

    • [x] Setup a README.md, with a description of the project, and a logo
    • [x] Create a CODE_OF_CONDUCT.md, and CONTRIBUTION_GUIDELINES.md for the project
    • [x] Add examples of usage to README.md
    • [x] Setup Issue templates, so people can open issues, work on existing ones, and report bugs following the previous guidelines. -> see https://github.com/ZK-Plus/ZnaKes/issues/new/choose
    • [x] Setup test an code coverage actions. Run test on PR and code coverage on main branch ->
    • [x] Setup repo to be post to pip. -> see pypi-test: https://test.pypi.org/project/ZnaKes/)
    • [x] Setup Github action to post to pip on each release -> see: .github/workflows/build-and-publish.yml)

  2. Release:

alv-around commented 9 months ago

Preview of test.pypi before official release: https://test.pypi.org/project/ZnaKes/

alv-around commented 9 months ago

@JonathanHeiss I've finished setting up the repo to make Znakes a robust package and publish it to to pypi.

This would be very helpful for people using ZoKrates, and would make easier for use to create tutorials.

When a 3rd student join us, we'll be able to get some traction.

Can you please review