This project has been archived by its maintainers, and is no longer receiving any updates.
Py4research: A step-by-step tutorial on how to build a Python package for research
Py4research provides a thorough tutorial on how to build and upload a Python package for research, which is going to be presented at the "X Workshop do Programa de Pós-Graduação em Ciência da Computação". Apart from the tutorial itself, we also implemented a straightforward package to illustrate how to build its package.
Guidelines
- Every needed piece of information is elucidated in this README;
- Installation is also straightforward and well-explained;
- If there is a problem, please do not hesitate and call us.
Installation
The installation process is straightforward as the package is hosted at PyPI, and the dependencies are listed on the requirements.txt file. One can install the package with either command, as follows:
pip install py4research
pip install -r requirements.txt
Additionally, the source files for the lecture are presented in LaTeX. Thus, one might need an additional compiler or even Overleaf to build the files into a PDF file.
Getting Started
This section provides an overview of the "build your python package" tutorial and the main package description.
Tutorial
The tutorial is written in Portuguese in a slide-based format. The contents are available in the slides folder and compiled to PDF using a LaTeX compiler.
Py4research
Py4research is a standard package composed of a single math module composed of two sub-modules: clustering and random. Essentially, the idea is to provide a simple framework that can foster research and help the community deploy their official implementations to PyPI.
Support
It is inevitable to make mistakes or create some bugs. If there is any problem or concern, we will be available at this repository or gustavo.rosa@unesp.br.
1 maintainer
Metadata
1 maintainer
Release files for py4research 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| py4research-1.0.1.tar.gz | 4.4 kB | Without provenance | Details |
Release files / py4research-1.0.1.tar.gz
| Download URL | py4research-1.0.1.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
267d1963e0d2eb2568b9faeb0ea127b1a7aac711fa93069396803147cd2efe02
|
|
BLAKE2b-256 checksum How to use checksums |
33e8d51c3522e6b8feaf9974d64fa5414917b597508d6d94a0a4bdcbf9eb2825
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200330 requests-toolbelt/0.9.1 tqdm/4.50.0 CPython/3.7.7
|
Security for py4research 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
