Skip to main content

THREE60 Energy rushmore-tools

release Code style: black

The rushmore-tools package is a lightweight wrapper for accessing Rushmore Reviews, a prominent player in benchmarking data collection for upstream oil & gas activities.

Overview

The collection contains utilities:

  • RushmoreExtractor

Usage

Simple usage. E.g. to download all Rushmore Drilling Performance Review data available to your API key, simply:

from rushmore_tools import RushmoreExtractor

report = RushmoreExtractor($api_key).report("DPR")
resp = report.get()

Development environment

We use poetry to manage dependencies and to administrate virtual environments. To develop rushmore-tools, follow the following steps to set up your local environment:

  1. Install poetry if you haven't already.

  2. Clone repository:

    $ git clone git@github.com:THREE60-Energy/rushmore-tools.git
    
  3. Move into the newly created local repository:

    $ cd rushmore-tools
    
  4. Create virtual environment and install dependencies:

    $ poetry install
    

Code requirements

All code must pass black and isort style checks to be merged. It is recommended to install pre-commit hooks to ensure this locally before commiting code:

$ poetry run pre-commit install

Each public method, class and module should have docstrings. Docstrings are written in the Google style.

Metadata

Release files for rushmore-tools 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rushmore-tools 1.0.2
File Size Uploaded Provenance Actions
rushmore_tools-1.0.2.tar.gz 8.3 kB Without provenance Details for rushmore_tools-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rushmore-tools 1.0.2
File Interpreter ABI Platform Actions
rushmore_tools-1.0.2-py3-none-any.whl Python 3 none any Details for rushmore_tools-1.0.2-py3-none-any.whl

Total release size: 21.8 kB

Release files / rushmore_tools-1.0.2.tar.gz

Download URL rushmore_tools-1.0.2.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1ad34de73452a95eea5a72be3f1e350a44a9b96f2b85143a1d249f68f80e1768
BLAKE2b-256 checksum
How to use checksums
0509efb62216dd29c606718ae49391da438ae8fb5d3096480b24686cf3b2df14
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.11.3 Windows/10

Release files / rushmore_tools-1.0.2-py3-none-any.whl

Download URL rushmore_tools-1.0.2-py3-none-any.whl
Size 13.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
83edc2d09d2f50940f9544400e73ac9e89f4369e27dfd47e7d2c33c229765a31
BLAKE2b-256 checksum
How to use checksums
3f0f8155ce5a5b31b8039510ec56c1bdf722071205156d008418e9c9b5c461af
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.4.2 CPython/3.11.3 Windows/10

Security for rushmore-tools 1.0.2

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page