Skip to content
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

Updating docs to use latest Jupysql #179

Closed
wants to merge 1 commit into from
Closed

Updating docs to use latest Jupysql #179

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
2 changes: 1 addition & 1 deletion docs/data-processing/postgresql/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Cross platform
orm
sqlalchemy
alembic
ipython-sql
jupysql
postgis/index
sec
performance
Expand Down
14 changes: 7 additions & 7 deletions ...ata-processing/postgresql/ipython-sql.rst → docs/data-processing/postgresql/jupysql.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
ipython-sql
Jupysql
===========

`ipython-sql <https://github.com/catherinedevlin/ipython-sql>`_ introduces the
`Jupysql <https://github.com/ploomber/jupysql>`_ introduces the
``%sql`` or ``%%sql`` magics for iPython and Jupyter notebooks.

Installation
------------

You can easily install ipython-sql in your Jupyter kernel with:
You can easily install jupysql in your Jupyter kernel with:

.. code-block:: console

$ pipenv install ipython-sql
$ pipenv install jupysql

First steps
-----------

#. First, ipython-sql is activated in your notebook with
#. First, Jupysql is activated in your notebook with

.. code-block:: python

Expand Down Expand Up @@ -103,7 +103,7 @@ If pandas is installed, the ``DataFrame`` method can be used:
PostgreSQL features
-------------------

Meta-commands from ``psql`` can also be used in ipython-sql:
Meta-commands from ``psql`` can also be used in jupysql:

``-l``, ``--connections``
lists all active connections
Expand All @@ -126,7 +126,7 @@ Meta-commands from ``psql`` can also be used in ipython-sql:
* `pgspecial <https://pypi.org/project/pgspecial/>`_

.. warning::
Since ipython-sql processes ``--`` options such as ``-persist``, and at the
Since jupysql processes ``--`` options such as ``-persist``, and at the
same time accepts ``--`` as a SQL comment, the parser has to make some
assumptions: for example, ``--persist is great`` in the first line is
processed as an argument and not as a comment.