Skip to content

feature: Using uv as new package manager (it's awesome 😎) #138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jusafing merged 1 commit into from
Feb 16, 2026
Merged

feature: Using uv as new package manager (it's awesome 😎) #138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 20 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,26 @@ structure you can check our [documentation](https://esquite.readthedocs.io/es/la

* `git`
* [Elasticsearch 7.6](https://www.elastic.co/guide/en/elasticsearch/reference/7.6/getting-started-install.html) or higher
* `python 3.7` or higher
* `poetry`
* `python 3.12` or higher
* `uv`

## Installation

1. Install and run `elasticsearch`

**Note**: Check the official page of
[Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
to complete this step depending on your OS. Alternatively you can use
[docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html) for easier installation.
> [!NOTE]
> Check the official page of
> [Elasticsearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/install-elasticsearch.html)
> to complete this step depending on your OS. Alternatively you can use
> [docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)
> for easier installation.


2. [Install](https://github.com/python-poetry/poetry#installation) `poetry` in
2. [Install](https://docs.astral.sh/uv/getting-started/installation/) `uv` in
your system

```shell
$ curl -sSL https://install.python-poetry.org | python3 -
curl -LsSf https://astral.sh/uv/install.sh | sh
```

3. Clone this repo
Expand All @@ -74,20 +76,21 @@ structure you can check our [documentation](https://esquite.readthedocs.io/es/la

```shell
$ cd Esquite
$ poetry install --no-dev --no root
$ poetry shell
$ uv sync --no-dev --no-group docs
$ source ./venv/bin/activate
```

5. Launch the installation wizard and type the information requested

```shell
(env)$ python wizard.py
(venv)$ python wizard.py
```

**Note**: The wizard automatically create an `elasticsearch` index.
Alternatively you can run the `curl` command below to create an index
manually before running the wizard.
Default configs can be founded in the file `elastic-config.json`
> [!TIP]
> The wizard automatically create an `elasticsearch` index.
> Alternatively you can run the `curl` command below to create an index
> manually before running the wizard.
> Default configs can be founded in the file `elastic-config.json`

```shell
$ curl -X PUT -H "Content-Type: application/json" -d @elastic-config.json localhost:9200/<index-name>
Expand All @@ -107,7 +110,8 @@ structure you can check our [documentation](https://esquite.readthedocs.io/es/la

8. Go to your browser at `http://localhost:8000/` to see Esquite running :)

**Note:** For an in detail deployment guide see please contact us
> [!NOTE]
> For an in detail deployment guide see please contact us

## Docker image alternative: `Esquite-Docker`

Expand Down
32 changes: 14 additions & 18 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,17 @@
import os
import sys
import django
sys.path.insert(0, os.path.abspath('../../'))
os.environ['DJANGO_SETTINGS_MODULE'] = 'esquite.settings'

sys.path.insert(0, os.path.abspath("../../"))
os.environ["DJANGO_SETTINGS_MODULE"] = "esquite.settings"
django.setup()


# -- Project information -----------------------------------------------------

project = 'Esquite'
copyright = '2022, Comunidad Elotl'
author = 'Comunidad Elotl'
project = "Esquite"
copyright = "2022, Comunidad Elotl"
author = "Comunidad Elotl"


# -- General configuration ---------------------------------------------------
Expand All @@ -31,19 +32,19 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinxcontrib.redoc',
"sphinx.ext.autodoc",
"sphinxcontrib.redoc",
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'es'
language = "es"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
Expand All @@ -56,21 +57,16 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "alabaster"

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['static']
html_static_path = ["static"]

# API documentation configs
redoc = [
{
'name': 'Esquite API',
'page': 'api',
'spec': 'openapi.yaml',
'embed': True
},
{"name": "Esquite API", "page": "api", "spec": "openapi.yaml", "embed": True},
]

redoc_uri = 'https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js'
redoc_uri = "https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"
Loading