Metadata-Version: 2.5
Name: equities-classifier
Version: 0.8.0
Summary: Package to retrieve sector/industry assignments based on a flexible connector architecture for different data sources
Project-URL: Documentation, https://dornech.github.io/equities-classifier
Project-URL: Source, https://github.com/dornech/equities-classifier
Project-URL: Tracker, https://github.com/dornech/equities-classifier/issues
Project-URL: Sponsor, https://github.com/sponsors/dornech
Author-email: dornech <dornech@gmx.de>
License: GPL-3.0-only
License-File: AUTHORS.md
License-File: LICENSE.txt
Keywords: GECS,GICS,MSCI,Morningstar,classification,equities,openFIGI,sector
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.11
Requires-Dist: freesimplegui
Requires-Dist: httpx
Requires-Dist: immutabledict
Requires-Dist: iso3166
Requires-Dist: lxml
Requires-Dist: openpyxl
Requires-Dist: py-gics-updated
Requires-Dist: rapidfuzz
Requires-Dist: selenium
Requires-Dist: undetected-updated
Requires-Dist: utils-mystuff
Requires-Dist: waitless
Description-Content-Type: text/markdown

# Sector/industry classifier for equities

Package to retrieve sector/industry assignments based on a flexible connector architecture for different data sources

## Features

* retrieve sector / industry classification for companies with listed equities
* support different types of equities identifier types cation (i. e. ISIN ...)
* support different classificaiton data sources
* extendable arhcitecture for additional data sources

Due to license issues for MSCI GICS only first two levels are retrievable.

## Development

To set up [hatch] and [pre-commit] for the first time:

1. install [hatch] globally, e.g. with [pipx], i.e. `pipx install hatch`,
2. make sure `pre-commit` is installed globally, e.g. with `pipx install pre-commit`.

A special feature that makes hatch very different from other familiar tools is that you almost never
activate, or enter, an environment. Instead, you use `hatch run env_name:command` and the `default` environment
is assumed for a command if there is no colon found. Thus you must always define your environment in a declarative
way and hatch makes sure that the environment reflects your declaration by updating it whenever you issue
a `hatch run ...`. This helps with reproducability and avoids forgetting to specify dependencies since the
hatch workflow is to specify everything directly in [pyproject.toml](pyproject.toml). Only in rare cases, you
will use `hatch shell` to enter the `default` environment, which is similar to what you may know from other tools.

To get you started, use `hatch run test:cov` or `hatch run test:no-cov` to run the unitest with or without coverage reports,
respectively. Use `hatch run lint:all` to run all kinds of typing and linting checks. Try to automatically fix linting
problems with `hatch run lint:fix` and use `hatch run docs:serve` to build and serve your documentation.
You can also easily define your own environments and commands. Check out the environment setup of hatch
in [pyproject.toml](pyproject.toml) for more commands as well as the package, build and tool configuration.

To support versioning and changelog generation please refer to the toolchain selected during package
generation (see also `pyproject.toml`). If not deselected, the toolchain includes a [pre-commit] hook
for linting commit messages to ensure commit messages are compliant with the conventional commit format and
support an automated changelog generation.

## Credits

This package was created with [The Hatchlor Enhanced] project template. This template is based on [The Hatchlor]
but was substantially improved.

[The Hatchlor Enhanced]: https://github.com/dornech/the-hatchlor-enhanced
[The Hatchlor]: https://github.com/florianwilhelm/the-hatchlor
[pipx]: https://pypa.github.io/pipx/
[hatch]: https://hatch.pypa.io/
[pre-commit]: https://pre-commit.com/
