mycityco2-data-process 0.1.1

No project description provided

MyCityCO2 Data Processing

Table of Contents

• Description
• Features
• Prerequisites
• Installation
• Usage
• Contributing
• License
• Contact

Description

MyCityCO2 Data Processing is a Python package designed to facilitate the import and export of municipality data from a country into Odoo, a popular Enterprise Resource Planning (ERP) system. This package provides functionality to import data from municipalities, perform data processing tasks, and export the processed data to CSV format.

Features

• Import data from various municipalities.
• Process and analyze the imported data.
• Export the processed data to CSV format.
• Command-line for easy interaction.
• Integration with Odoo ERP system.

Prerequisites

• Python > 3.8
• Access to an Odoo system (not optional)

Installation

1. Clone this repository to your local machine:

git clone https://github.com/MyCityCO2/mycityco2-data-processing.git

2. Navigate to the project directory:

cd mycityco2-data-processing

3. Run using poetry in dev mode:

poetry run mycityco2 run fr --departement=74

Or Install directly the package:

pip install mycityco2-data-process

Usage

MyCityCO2 Data Processing is designed to be run as a Command-Line Interface (CLI) application using the Typer module.

To run the project, use the following command:

mycityco2 run <importer> --departement <departement>

For example:

mycityco2 run fr --departement 74

You can also use --help to get an overview of the project:

mycityco2 --help

Contributing

Contributions to MyCityCO2 Data Processing are welcomed. To add new features or fix bugs, please follow these steps:

• Fork the mycityco2-data-processing repository on GitHub.
• Create a new branch for your feature or bugfix: git checkout -b my-new-feature-or-fix.
• Add your code and tests for the new feature or fix.
• Commit your changes: git commit -m 'Add my new feature or fix'.
• Push your changes to your forked repository: git push origin my-new-feature-or-fix.
• Open a pull request to merge your changes into the main branch.
• The maintainers will review your contribution as soon as possible!

License

This project is licensed under the GNU Affero General Public License v3.0. Please refer to the LICENSE file for more information.

Contact

For any inquiries, feedback, or issues, please contact:

• Adam Bonnet ([e-mail])
• Remy Zulauff ([e-mail])