Skip to main content

The Python package for econometric analysis.

Project description

EconomPy - The Econometric Python Library

Python License: MIT Build codecov Documentation

The motivation behind the EconomPy library is to provide a set of tools for econometric analysis in Python. Instead of using R (Studio) or Stata for econometric analysis, the goal is to provide a Python alternative.

The EconomPy library is a collection of econometric functions and classes written in Python. The library is designed to be used in conjunction with the Pandas library.

Installation

For the latest stable version, install from PyPi:

# Create a virtual environment
python -m venv .venv

# Activate the virtual environment
source .venv/bin/activate

# Install the package from PyPi
pip install econompy

Usage

import econompy as ep

Development

To contribute to the development of EconomPy, clone the repository and install the development dependencies.

Install the Development Dependencies

# Clone the repository
git clone https://github.com/malill/econompy.git

# Create a virtual environment
python -m venv .venv

# Install the development dependencies
pip install -r requirements-dev.txt

# Install the package in editable mode
pip install -e .

Use pre-commit hooks

The pre-commit hooks are used to ensure that the code is formatted correctly and that the tests pass before committing the code.

# Install the pre-commit package
pre-commit install

# (To locally) Run the pre-commit hooks
pre-commit run --all-files

Run Code Coverage

You can test the code coverage by running the following command:

# Run the code coverage
pytest --cov=econompy --cov-report=html

This will generate a HTML report in the htmlcov folder. Inspect the report by opening the index.html file in your browser.

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

econompy-0.1.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

econompy-0.1.0-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file econompy-0.1.0.tar.gz.

File metadata

  • Download URL: econompy-0.1.0.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for econompy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 64c79f1cd8f2968fdbad06e10a395f58d48ac0c94af74836298a04bcf2fb5ecf
MD5 8cf71d81b8ab48407da30191adfd2d4a
BLAKE2b-256 738d995a09fdde9ae3dfa054de293f710e7b94a5616746228d9cc8c9ac6b5db9

See more details on using hashes here.

File details

Details for the file econompy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: econompy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for econompy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c6ef169d0694928880804ecb00d1d07284bfd53a8ed75352af899c703e2ab56a
MD5 3453d5a12c64dc0f45d528a7a6ce7b31
BLAKE2b-256 88d5d0daf7b44610e3f64925f0b7e9113c8172cca4bc36fa75da5cea4a21fbfd

See more details on using hashes here.

Supported by

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