Skip to content

Commit

Permalink
fix: readme (#393)
Browse files Browse the repository at this point in the history
* fix: readme

* Fix docs
  • Loading branch information
betodealmeida authored Oct 21, 2023
1 parent cbeb624 commit b6f1b8f
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 11 deletions.
4 changes: 4 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

# Required
version: 2
build:
os: "ubuntu-22.04"
tools:
python: "3.11"

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
2 changes: 2 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Shillelagh

Shillelagh (ʃɪˈleɪlɪ) is a Python library and CLI that allows you to query many resources (APIs, files, in memory objects) using SQL. It's both user and developer friendly, making it trivial to access resources and easy to add support for new ones.

Learn more on the `documentation <https://shillelagh.readthedocs.io/en/latest/>`_.

The library is an implementation of the `Python DB API 2.0 <https://www.python.org/dev/peps/pep-0249/>`_ based on `SQLite <https://sqlite.org/index.html>`_ (using the `APSW <https://rogerbinns.github.io/apsw/>`_ library):

.. code-block:: python
Expand Down
14 changes: 3 additions & 11 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -101,26 +101,18 @@ all =
appdirs>=1.4.4
beautifulsoup4>=4.11.1
boto3>=1.24.28
codespell>=2.1.0
freezegun>=1.1.0
defusedxml>=0.7.1
google-auth>=1.23.0
html5lib>=1.1
jsonpath-python>=1.0.5
pandas>=1.2.2
pip-tools>=6.4.0
pre-commit>=2.13.0
prison>=0.2.1
prompt_toolkit>=3
psutil>=5.8.0
pyfakefs>=4.3.3
pygments>=2.8
pylint>=2.16.2
pytest-cov>=2.11.1
pytest-integration==0.2.2
pytest-mock>=3.5.1
pytest>=6.2.2
requests-cache>=0.7.1
requests-mock>=1.8.0
tabulate==0.8.9
yarl>=1.8.1
docs =
sphinx>=4.0.1
console =
Expand Down

0 comments on commit b6f1b8f

Please sign in to comment.