Skip to main content

Convenience functions.

Project description

PyPIPython build Issues
Downloads GNU License

logo

roux

Convenience functions in Python.
Examples · Explore the API

image

Examples

⌗ Dataframes.
⌗⌗ Paired Dataframes.
💾 General Input/Output.
⬤⬤ Sets.
🔤 Strings encoding/decoding.
🗃 File paths Input/Output.
🏷 Classification.
✨ Clustering.
✨ Correlations.
✨ Differences.
📈 Data fitting.
📊 Data normalization.
⬤⬤ Comparison between sets.
📈🔖Annotating visualisations.
🔧 Subplot-level adjustments.
📈 Diagrams.
📈 Distribution plots.
📈 Wrapper around Series plotting functions.
📈📈Annotating figure.
📈💾 Visualizations Input/Output.
📈 Line plots.
📈 Scatter plots.
📈⬤⬤ Plots of sets.
📈🎨✨ Visualizations theming.
⚙️🗺️ Reading multiple configs.
⚙️⏩ Running multiple tasks.
⚙️⏩ Workflow using notebooks

Installation

pip install roux              # with basic dependencies  
pip install roux[all]         # with all the additional dependencies (recommended). 

With additional dependencies as required:

pip install roux[viz]         # for visualizations e.g. seaborn etc.
pip install roux[data]        # for data operations e.g. reading excel files etc.
pip install roux[stat]        # for statistics e.g. statsmodels etc.
pip install roux[fast]        # for faster processing e.g. parallelization etc.
pip install roux[workflow]    # for workflow operations e.g. omegaconf etc.
pip install roux[interactive] # for interactive operations in jupyter notebook e.g. watermark, icecream etc.

Command-line usage

ℹ️ Available command line tools and their usage.
roux --help

⭐ Remove *'s from a jupyter notebook'.
roux removestar path/to/notebook

🗺️ Read configuration.
roux read-config path/to/file

🗺️ Read metadata.
roux read-metadata path/to/file

📁 Find the latest and the oldest file in a list.
roux read-ps list_of_paths

💾 Backup a directory with a timestamp (ISO).
roux backup path/to/directory

How to cite?

  1. Using BibTeX:
@software{Dandage_roux,
  title   = {roux: Streamlined and Versatile Data Processing Toolkit},
  author  = {Dandage, Rohan},
  year    = {2024},
  url     = {https://zenodo.org/doi/10.5281/zenodo.2682670},
  version = {0.1.2},
  note    = {The URL is a DOI link to the permanent archive of the software.},
}
  1. DOI link: DOI, or

  2. Using citation information from CITATION.CFF file.

Future directions, for which contributions are welcome

  • Addition of visualization function as attributes to rd dataframes.
  • Refactoring of the workflow functions.

Similar projects

API

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

roux-0.1.4.tar.gz (239.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

roux-0.1.4-py3-none-any.whl (270.2 kB view details)

Uploaded Python 3

File details

Details for the file roux-0.1.4.tar.gz.

File metadata

  • Download URL: roux-0.1.4.tar.gz
  • Upload date:
  • Size: 239.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for roux-0.1.4.tar.gz
Algorithm Hash digest
SHA256 cf14b7d6d78adbe882d1e7c084703455bf9f3d128e2007d642d79e7b1d2c80fd
MD5 971c3e84763614cf3d6683723db6a93f
BLAKE2b-256 d4c9096ce0206d0e86625ff9c06091a6cc6675f67abc8dccc671fba6400cd6b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for roux-0.1.4.tar.gz:

Publisher: python-publish.yml on rraadd88/roux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file roux-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: roux-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 270.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for roux-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 29dadc367f78d054d3b7da6538393a5d069d223b897eb9f8eed668cc98309efd
MD5 472f72ec8fe78d89b992ae091386feeb
BLAKE2b-256 ef51f5efee6d1aac0fed42994e488003cefb518c2c0fb7ce1fdb710d8a8ff4a9

See more details on using hashes here.

Provenance

The following attestation bundles were made for roux-0.1.4-py3-none-any.whl:

Publisher: python-publish.yml on rraadd88/roux

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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