Metadata-Version: 2.1
Name: globadoo
Version: 0.1.1
Summary: A CLI tool for finding countries based on city names using OpenAI's chat model
License: MIT
Author: Daniel Tom
Author-email: d.e.tom89@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: openai (>=1.36.0,<2.0.0)
Requires-Dist: pydantic (>=2.8.2,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: typer (>=0.12.3,<0.13.0)
Description-Content-Type: text/markdown

# Globadoo

Globadoo is a Python library for finding the country of a given city using OpenAI chat model.

## Installation

To install Globadoo, use the following command:

```
pip install globadoo
```

## Usage

Here's a basic example of how to use Globadoo:

```
pipx install globadoo
export OPENAI_API_KEY="your-api-key"
globadoo "New York"
```
This returns
    
    {"city":"New York","country":"United States","country_code":"US"}

## API Reference

The main function of Globadoo is `find_country(city, llm_config)`, which takes a city name and an LLMConfig model as arguments and returns the country of the city.

## Tests

To run the tests for Globadoo, use the following command:

```
pytest tests
```

## Contributing

Contributions to Globadoo are welcome. Please submit a pull request with your changes.

## License

Globadoo is licensed under the MIT License.

## Contact

For any questions or concerns, please open an issue on the GitHub repository.
