Metadata-Version: 2.1
Name: carbonfootprint
Version: 1.2.4
Summary: carbon footprint of the power consumption by fuel mix. Calculates carbon footprint based on fuel mix and discharge profile at the utility selected. Can create graphs and tabular output for fuel mix based on input file of series of power drawn over a period of time.
Home-page: https://github.com/renewable-energy-experiments/carbon-footprint-calculator
Author: Altanai
Author-email: tara181989@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/renewable-energy-experiments/carbon-footprint-calculator/issues
Keywords: carbon-emission,energy-efficiency,utility-fuel-mix
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas

# carbon-footprint-calculator

[![Carbonfootprint Latest PY Release](https://img.shields.io/badge/carbonfootprint-latest%20release-pink)](https://pypi.org/project/carbonfootprint/)
[![Carbonfootprint Latest Anaconda Release](
https://anaconda.org/altanai/carbonfootprint/badges/version.svg)](https://anaconda.org/altanai/carbonfootprint)


[![Carbonfootprint Status](https://img.shields.io/badge/status-stable-brightgreen)](https://pypi.org/project/carbonfootprint/#history)
[![License](https://img.shields.io/github/license/renewable-energy-experiments/carbon-footprint-calculator)](https://github.com/renewable-energy-experiments/carbon-footprint-calculator/blob/main/LICENSE)
[![Issues](https://img.shields.io/github/issues/renewable-energy-experiments/carbon-footprint-calculator)](https://github.com/renewable-energy-experiments/carbon-footprint-calculator/issues)

[![Twitter](https://img.shields.io/twitter/url?url=https%3A%2F%2Fgithub.com%2Frenewable-energy-experiments%2Fcarbon-footprint-calculator
)](https://twitter.com/altanai)
[![Stars](https://img.shields.io/github/stars/renewable-energy-experiments/carbon-footprint-calculator)](https://github.com/renewable-energy-experiments/carbon-footprint-calculator/stargazers)

## Conda distribution

    ~/anaconda3/bin/conda install anaconda-client conda-build
    ~/anaconda3/bin/conda config --set anaconda_upload no
    ~/anaconda3/bin/conda build . --output

    ~/anaconda3/bin/anaconda login
    ~/anaconda3/bin/anaconda upload dist/carbonfootprint-1.1.5.tar.gz
 
Referneces 
 - https://docs.anaconda.com/anacondaorg/user-guide/tasks/work-with-packages/
 - published package  https://anaconda.org/altanai/carbonfootprint
 
## PYppi ditribution 

**1. Generating distribution archives**

First install latest version of PyPA’s build then build . This should generate dist directory:

    python3 -m pip install --upgrade build
    python3 -m build
    
**2. Uploading the distribution archives**

    python3 -m pip install --upgrade twine
    twine check dist/*
    
        Checking dist/carbon_footprint_calculator-1.1.1-py3-none-any.whl: PASSED
        Checking dist/carbon_footprint_calculator-1.1.1.tar.gz: PASSED

Install twine and upload all of the archives under dist to pypi’s test server

    python3 -m twine upload --repository testpypi dist/*
    
or to pyapi
    
    python3 -m twine upload dist/*
    
**3.Installing the package**

From pytest 

    python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps carbonfootprint

From pyapi

    pip3 install carbonfootprint

References :
 - List of classifiers - https://pypi.org/classifiers/ 
 - published carbonfootprint package on pyapii https://pypi.org/project/carbonfootprint/

## Test Enviornment 

Install and Setup Conda 

    export PATH=$PATH:/home/altanai/anaconda3/bin
    
Activate virtual env 

     source energycarbon_env/bin/activate
     
Run unit tests 

    python tests/unittests.py
 
 
## Debugging and Help
 
**Issue1** Adding csv for the datasets 

**solution** refer to https://python-packaging.readthedocs.io/en/latest/non-code-files.html 
Add the following to dynamic setup.py 

    include_package_data=True
    package_data={'': ['dataset/*']},

