Diretório de pyprojecto.toml incorreto em instruções para instalação em modo DEV

[pitangainnovare]

README indica diretório incorreto para instalação

Descrição do problema

Ao seguir as instruções do README, o comando de instalação é executado no diretório incorreto.

O README informa apenas:

From the project directory:

Entretanto, o arquivo pyproject.toml está localizado no subdiretório spsvalidator/spsvalidator.

Passos para reproduzir o problema

1. Acesse o diretório raiz do repositório:

   cd spsvalidator

2. Crie e ative o ambiente virtual conforme descrito no README.

3. Execute:

   python -m pip install -e ".[dev]"

4. Observe o erro:

   (.venv) (base) user@hostname:~/spsvalidator$ python -m pip install -e ".[dev]"
   Obtaining file:///home/user/spsvalidator
   ERROR: file:///home/user/spsvalidator does not appear to be a Python project: neither 'setup.py' nor 'pyproject.toml' found.
   

5. Acesse o subdiretório interno:

   cd spsvalidator

6. Execute novamente:

   python -m pip install -e ".[dev]"

7. Observe que a instalação é realizada corretamente.

Comportamento esperado

O README deve informar explicitamente que o comando de instalação precisa ser executado no diretório que contém o arquivo pyproject.toml:

cd spsvalidator/spsvalidator
python -m pip install -e ".[dev]"

Alternativamente, o pyproject.toml poderia ser movido para o diretório raiz do repositório.

Screenshots ou vídeos

Não se aplica. O log completo do erro está apresentado nos passos para reprodução.

Anexos

Não se aplica.

Ambiente utilizado

• Sistema operacional: Linux

• Shell: Bash

• Ambiente virtual Python: .venv

• Diretório raiz:

  /home/user/spsvalidator
  

• Diretório que contém o pyproject.toml:

  /home/user/spsvalidator/spsvalidator