Skip to main content

Collection of utilities for R&D coding in Python 🐍

Project description

py-research

PyPI - Version Docs Tests Build Ruff Black Codecov CodeFactor CodeClimate Maintainability

About this project

This repository is a collection of Python utilities to help you analyze & visualize data, automate workflows and manage knowledge while working in an interdisciplinary R&D project. More precisely, it serves these main puposes:

  1. Extend existing, well-established packages (e.g. pandas, numpy sqlalchemy, structlog, ...) with small helper functions and abstractions to provide lacking functionality or make them easier to use & automate.
  2. Enforce best practices on scientific code to make it more reliable, quick to deploy, and easy to monitor.
  3. Provide a framework for knowledge and information management backed by different data sources and databases, to which analysis / dataviz functions can tie in seamlessly.

Current status

This project is actively maintained, but still under construction. The modules in their current form are working and continuously tested, but documentation is still minimal and many components of the framework are not yet implemented. Release versioning follows the Semver Spec, so breaking changes in existing API will only happen with major version upgrades, of which there are expected to be a few before the framework is complete.

Furthermore, some of the current functionality may be outsourced into a separate repo and package with these upgrades.

How to install

py-research is available as a Python package on PyPI:

pip install py-research

Alternatively, you can install it directly from git via:

pip install git+https://github.com/cloudlane-one/py-research.git

Contents

docs/ref-api/index

Indices and Tables

  • {ref}genindex
  • {ref}modindex
  • {ref}search

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_research-5.1.0.tar.gz (71.5 kB view details)

Uploaded Source

Built Distribution

py_research-5.1.0-py3-none-any.whl (69.5 kB view details)

Uploaded Python 3

File details

Details for the file py_research-5.1.0.tar.gz.

File metadata

  • Download URL: py_research-5.1.0.tar.gz
  • Upload date:
  • Size: 71.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for py_research-5.1.0.tar.gz
Algorithm Hash digest
SHA256 8fda5703067b5630334412a5c53dbb976eb9157f6bf00a60cc44806ef80f77b5
MD5 af9de2330188f13450e736eed6bb6b92
BLAKE2b-256 09af876f2fb654c01c88ae0ae823fcfd47f0f7ccd3786ea14df3414d7ec19684

See more details on using hashes here.

File details

Details for the file py_research-5.1.0-py3-none-any.whl.

File metadata

  • Download URL: py_research-5.1.0-py3-none-any.whl
  • Upload date:
  • Size: 69.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for py_research-5.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aecddfaf72b80522a1af42ec9e76380c380fd542934b7b8a2134a4c17ff7e6d7
MD5 b184289478f0ca8dd065484be6d33c21
BLAKE2b-256 e3de89b02987340baaccb7c5122758445dd8e7cf88ec45acaaf4fe65ad71a814

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page