Metadata-Version: 2.1
Name: dirx
Version: 0.3.0
Summary: 
Home-page: https://github.com/alexisbeaulieu97/dirx
License: MIT
Author: Alexis Beaulieu
Author-email: alexisbeaulieu@protonmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: pydantic (>=2.3.0,<3.0.0)
Requires-Dist: pydantic-settings (>=2.0.3,<3.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Requires-Dist: watchdog (>=3.0.0,<4.0.0)
Project-URL: Repository, https://github.com/alexisbeaulieu97/dirx
Description-Content-Type: text/markdown

<a name="readme-top"></a>

<div align="center">
  <h1 align="center">dirx</h1>

  <p align="center">
    TODO
    <br />
    <br />
    <a href="https://github.com/alexisbeaulieu97/dirx/issues">Report Bug</a>
    ·
    <a href="https://github.com/alexisbeaulieu97/dirx/issues">Request Feature</a>
  </p>
</div>

<br />
<br />

# About the project

TODO

> **Warning** This project is in early development and is rapidly evolving.
> This means you can expect:
>
> - Missing features
> - No stability guarantees
> - Bugs

# Getting Started

## Prerequisites

This project requires python 3.11 or later to be installed.

## Installation

It is recommended to use a virtual environment to install dirx and avoid conflicts with other packages. You can create and activate a virtual environment with:

```
python -m venv env
```

To activate the virtual environment, you can use the following command depending on your platform:

- On Windows, run:

```
env\Scripts\activate.bat
```

- On Unix or MacOS, run:

```
source env/bin/activate
```

Installation can be done using pip:

```
pip install dirx
```

To verify that dirx was installed correctly, you can run:

```
dirx --version
```

## Usage

Coming soon

# License

See the [LICENSE](LICENSE) file.

# Authors

- [Alexis Beaulieu](https://www.linkedin.com/in/alexisbeaulieu/)

<p align="right"><a href="#readme-top">back to top</a></p>

