Using a crate called cargo-rpm we can easily create a .rpm package for our project which should later be added to the release files. Bare in mind that a new testing CI job will be required to make sure it's working.

Related to:

• #44
• #42
• #51

Blocked by:

• #31

Part of #1

Investigate how to communicate with PyPi in order to get the necessary information about packages, send requests for downloading them etc

Please create an .md file describing your findings so that other after reading it can understand what you discovered
preferably name the file PyPi_communication.md or something like that

Description

Thoughts on keeping dependencies up to date?

https://github.blog/2020-06-01-keep-all-your-packages-up-to-date-with-dependabot/

Checklist

• Add a dependabot.yml

Add code coverage checking CI job using tarpauling (https://crates.io/crates/cargo-tarpaulin) or any other tool that does that, then add a README badge for the coverage state.

• https://crates.io/crates/cargo-tarpaulin

Related to #7 and #8, just that we need to translate the requirements,txt file (and maybe give it a easier usage in the CLI, something like pip.rs install-requirements or something like that) so that we can get the package the requirements.txt file requires from the PyPi index

Notes

• https://pypi.org/pypi/PACKAGE/VERSION/json according to the official docs on this API

Problems

• Version Operators (e.g. ==, >=, etc.)
  • The JSON API does not support this
  • Probably not a big issue here, as there's no rate-limiting
  • I also don't know if pip supports the other operators besides ==
• Python version verification
• A robust way to parse requirements.txt
  • Very doubtful that this actually works, so half a tick

See Also

• #18

mdBook is a template for creating documentation in markdown. It is mainly used for rust projects, but the template just like markdown itself is language agnostic, it's just a markup language. Start creating documentation for the project using it (in the future it would be accessible by github.io
https://github.com/rust-lang/mdBook

Part of #1 task.

• Investigate all possible project setups that can be used in Python projects (setup.py, pyproject.toml etc.)
• What tools are needed to build/create a Python package?
• How does creating a package look like?
• How does a Python package look like inside when it's already created/or what types of packages are there (so like wheel etc)?
• How are dependencies resolved?

PART OF #2 Task
Investigate all possible setups required in python setup like setup.py

Add a changelog file. What is a changelog file:

• https://www.youtube.com/watch?v=Pi8akLplC9M&ab_channel=NickJanetakis
• https://keepachangelog.com/en/1.0.0/

even though the project isn't been doing anything, it would be great for temporary basis that we provide info on how to run for development purposes...

Using a crate called cargo-arch we can easily create an arch package for our project which should later be added to the release files. Bare in mind that a new testing CI job will be required to make sure it's working.

Related to:

• #42
• #45
• #51

Blocked by:

• #31

Using a crate called cargo-deb we can easily create a .deb package for our project which should later be added to the release files. Bare in mind that a new testing CI job will be required to make sure it's working.

Related to:

• #44
• #45
• #51

Blocked by:

• #31

Related to:

• #29

Extend the current CI/CD configuration to add automatic releases on release branch, builds, test etc on other toolchain channels etc

Introduced in 36198f7

Create a docker image for using rust-pip. (Its creation should be a part of the release workflow)

Blocked by:

• #31

Add a markdownlint job to the Makefile.toml (cargo-make)

https://github.com/markdownlint/markdownlint

Investigate Python packaging:

• Investigate how packages are built/created
• Investigate how packages are downloaded and then used/put into the right place
• Investigate how to communicate and work with PyPi (and later other packages registered for Python)

Using a crate called cargo-arch we can easily create an arch package for our project which should later be added to the release files. Bare in mind that a new testing CI job will be required to make sure it's working.

Related to:

• #42

Blocked by:

• #31

Add status badges to the README:
https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/adding-a-workflow-status-badge

This is related to the issue #8
Attached are preliminary details which breeds some further questions.
Python Library Installation.txt

Add a CI Job that confirms the linting of all Markdown files within the project.

Related / Startingpoint:

• Markdown Linting Action

Add CI/CD workflows that automatically detect if a commit is tagged on master and push it to the release branch and release it using GitHub release feature. The release file should contain the source code and compilation artifacts. Follow the procedure described in the branching strategy in the README.

(As of now not implemented)
Blocked by:

• #28

Make sure that the CHANGELOG file is added to the project's documentation and visible to whoever is reading it.

Blocked by:

• #32
• #30

Part of #1
Probably #7 needs to be completed first

Investigate how to actually download a Python package and on what basis is it decided where and how to put it somewhere

Add a strategy matrix to the CI jobs for additional runs on Windows and macOS

Add a CI job that generates documentation that we have stored in our project and produces some readable format that can be either downloaded or publish as a web page.
Rust has two types of documentation:

• The API documentation which is something you can read on creates.io
• A Rust Book for a given project that is a more abstract representation of a project and usually has some guides, tutorials etc

Blocked by:

• #34
• #33
• #32
• #31
• #30

Add a Ci job that would check that the CHANGELOG file has gotten updated with a given Pull Request.
A simple git diff between the feature branch and the target branch will be enough.

Blocked by:

• #32

Crate a package generating release CI job in the release workflow for our project which should later be added to the release files. Bare in mind that a new testing CI job will be required to make sure it's working. The package should be for Alpine (preferably find a tool similar to (cargo-deb that generates it from a rust project).

Related to:

• #45
• #44
• #42

Blocked by:

• #31

Description

Add cargo-audit job to the CI

• https://crates.io/crates/cargo-audit

Checklist

• Connect all related issues, and project boards, add labels, assign people, milestones etc.
• Make sure that this template is properly filled in and appropriate parts deleted

Part of the #2 task

Investigate what tools are needed to build/create a Python package

Create API to recive Package information from Warehouse Instances as described in

• #7
• #13

Implement a parser for Python package versions as described in Pep-440

This includes things such as:

• Ordering Operations
• Unit tests
• etc

Releated

• #1