Metadata-Version: 2.4
Name: s6r-sirene
Version: 1.0.1.2
Summary: SIRENE and INSEE API client
Author-email: Michel Perrocheau <michel@scalizer.fr>
License-Expression: MIT
Project-URL: Homepage, https://github.com/ScalizerOrg/s6r-sirene
Project-URL: Changelog, https://github.com/ScalizerOrg/s6r-sirene/blob/main/CHANGELOG.md
Keywords: sirene,insee,api
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pandas>=3.0.1
Requires-Dist: tqdm
Requires-Dist: platformdirs
Requires-Dist: unidecode
Requires-Dist: urllib3
Requires-Dist: requests
Requires-Dist: requests-ratelimiter
Provides-Extra: dev
Requires-Dist: twine; extra == "dev"
Requires-Dist: bumpver; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: check-manifest; extra == "dev"
Dynamic: license-file

# s6r-sirene

A lightweight alternative to [pynsee](https://github.com/InseeFrLab/pynsee) for accessing French SIRENE and other INSEE data without the pyarrow dependency.

## Overview

This package provides a simplified interface to access INSEE's SIRENE database and other INSEE data sources, inspired by pynsee but without the pyarrow dependency and without geodata. It's designed to be lightweight and easy to use for basic INSEE data retrieval needs.

## Features

- Access to SIRENE company and establishment data
- Lightweight alternative to pynsee
- No pyarrow dependency
- Simplified API for common use cases

## Installation

```bash
pip install -r requirements.txt
```

## Usage

```python
from s6r_sirene.sirene import get_sirene_data, search_sirene
from s6r_sirene.utils import init_conn
init_conn(sirene_key='secret-xxx')
# Search for companies by name
results = search_sirene("company name")
# Get company data by SIRET
results = get_sirene_data('84767686300040')
```

## Why this fork?

This project was created to provide a lightweight alternative to pynsee that doesn't require pyarrow, which can be challenging to install in some environments. It maintains compatibility with the core functionality while being more lightweight.

## License

[MIT](LICENSE)

## Contributors

* Michel Perrocheau - [GitHub](https://github.com/myrrkel)


## Maintainer

This software is maintained by [Scalizer](https://www.scalizer.fr).


<div style="text-align: center;">

[![Scaliser](./logo_scalizer.png)](https://www.scalizer.fr)

</div>
