diff --git a/README.rst b/README.rst index 931402b..5772098 100644 --- a/README.rst +++ b/README.rst @@ -4,10 +4,8 @@ SPDX-License-Identifier: MIT -sqliteimport -############ - -*Import Python code from sqlite databases.* +.. image:: docs/_static/banner.png + :alt: sqlite import: Import Python code in sqlite databases. ------------------------------------------------------------------------------- @@ -42,4 +40,49 @@ This is the output: The database format is likely to change as the project matures. + +Attributions +============ + +The sqliteimport logo and banner build on others' work. + +* The package in the logo is `Emoji 1F4E6`_ + and is designed by `OpenMoji`_, the open-source emoji and icon project. + + License: `CC BY-SA 4.0`_ + +* The feather in the logo is `Emoji 1FAB6`_ + and is designed by `OpenMoji`_, the open-source emoji and icon project. + + License: `CC BY-SA 4.0`_ + +* The phrase "sqlite import" in the banner uses the `Dancing Script v2.031`_ font + and is designed by `Pablo Impallari `_. + + License: `SIL Open Font License, v1.1 `_ + +* The phrase "Import Python code from sqlite databases" in the banner uses the `Noto Sans`_ font + and designed by the `Noto Project`_. + + License: `SIL Open Font License, version 1.1 `_ + +* The logo and banner were pieced together using `Inkscape`_. + + License: `GNU GPL, version 2`_ + + +.. Links +.. ----- +.. .. _the sqliteimport repository: https://github.com/kurtmckee/sqliteimport +.. _Emoji 1F4E6: https://openmoji.org/library/emoji-1F4E6/ +.. _Emoji 1FAB6: https://openmoji.org/library/emoji-1FAB6/ +.. _OpenMoji: https://openmoji.org/ +.. _CC BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/ +.. _Dancing Script v2.031: https://github.com/impallari/DancingScript/tree/7f1738a1e8034404b1985c442af480155c603955 +.. _Dancing Script license: https://github.com/impallari/DancingScript/blob/7f1738a1e8034404b1985c442af480155c603955/OFL.txt +.. _Dancing Script author: https://github.com/impallari +.. _Noto Project: https://github.com/notofonts/latin-greek-cyrillic +.. _Noto Sans License: https://github.com/notofonts/latin-greek-cyrillic/blob/4bc63d7ebca1faed49c6c685f380ba0abc2c1941/OFL.txt +.. _Inkscape: https://inkscape.org/ +.. _GNU GPL, version 2: https://inkscape.org/about/license/ diff --git a/assets/banner.svg b/assets/banner.svg index 7e2456a..78a19ce 100644 --- a/assets/banner.svg +++ b/assets/banner.svg @@ -8,14 +8,17 @@ version="1.1" id="svg1" xml:space="preserve" - inkscape:version="1.3.1 (9b9bdc1480, 2023-11-25, custom)" + inkscape:version="1.3.2 (091e20e, 2023-11-25, custom)" sodipodi:docname="banner.svg" + inkscape:export-filename="..\docs\_static\banner.png" + inkscape:export-xdpi="96" + inkscape:export-ydpi="96" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg">sqliteimport + transform="translate(-13.530182,-101.8304)">sqlite importImport Python code from sqlite databases diff --git a/assets/logo.svg b/assets/logo.svg index fd14096..67e3980 100644 --- a/assets/logo.svg +++ b/assets/logo.svg @@ -8,14 +8,17 @@ version="1.1" id="svg1" xml:space="preserve" - inkscape:version="1.3.1 (9b9bdc1480, 2023-11-25, custom)" + inkscape:version="1.3.2 (091e20e, 2023-11-25, custom)" sodipodi:docname="logo.svg" + inkscape:export-filename="..\docs\_static\logo.png" + inkscape:export-xdpi="96" + inkscape:export-ydpi="96" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns="http://www.w3.org/2000/svg" xmlns:svg="http://www.w3.org/2000/svg"> h1:first-child { + clip: rect(0 0 0 0); + clip-path: inset(50%); + height: 1px; + overflow: hidden; + position: absolute; + white-space: nowrap; + width: 1px; +} diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..2a19c0d Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py index 44386c3..c73a9cb 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,12 @@ # ------------------------ html_theme = "alabaster" +html_static_path = [ + "_static", +] html_theme_options = { + # "logo": "logo.png", + # "logo_name": "sqliteimport", # Link to GitHub "github_user": "kurtmckee", "github_repo": "sqliteimport", diff --git a/docs/index.rst b/docs/index.rst index e977d0d..98025c7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,4 +4,91 @@ SPDX-License-Identifier: MIT -.. include:: ../README.rst +.. rst-class:: visually-hidden + +sqliteimport +############ + +.. image:: _static/banner.png + :alt: sqlite import: Import Python code in sqlite databases. + +------------------------------------------------------------------------------- + +Demo usage example, using ``demo.py`` in `the sqliteimport repository`_: + +.. code-block:: bash + + # Ensure sqliteimport is installed with the 'cli' extra. + pip install sqliteimport[cli] + + # Install 'requests' in a standalone directory. + pip install --target=sample requests + + # Generate a sqlite database containing the installed packages. + sqliteimport bundle sample sample.sqlite3 + + # Demonstrate that importing from a database works. + python demo.py sample.sqlite3 + + +This is the output: + +.. code-block:: console + + $ python demo.py + The requests module object: + + + Requesting a webpage...success! + +.. warning:: + + The database format is likely to change as the project matures. + + +Attributions +============ + +The sqliteimport logo and banner build on others' work. + +* The package in the logo is `Emoji 1F4E6`_ + and is designed by `OpenMoji`_, the open-source emoji and icon project. + + License: `CC BY-SA 4.0`_ + +* The feather in the logo is `Emoji 1FAB6`_ + and is designed by `OpenMoji`_, the open-source emoji and icon project. + + License: `CC BY-SA 4.0`_ + +* The phrase "sqlite import" in the banner uses the `Dancing Script v2.031`_ font + and is designed by `Pablo Impallari `_. + + License: `SIL Open Font License, v1.1 `_ + +* The phrase "Import Python code from sqlite databases" in the banner uses the `Noto Sans`_ font + and designed by the `Noto Project`_. + + License: `SIL Open Font License, version 1.1 `_ + +* The logo and banner were pieced together using `Inkscape`_. + + License: `GNU GPL, version 2`_ + + +.. Links +.. ----- +.. +.. _the sqliteimport repository: https://github.com/kurtmckee/sqliteimport +.. _Emoji 1F4E6: https://openmoji.org/library/emoji-1F4E6/ +.. _Emoji 1FAB6: https://openmoji.org/library/emoji-1FAB6/ +.. _OpenMoji: https://openmoji.org/ +.. _CC BY-SA 4.0: https://creativecommons.org/licenses/by-sa/4.0/ +.. _Dancing Script v2.031: https://github.com/impallari/DancingScript/tree/7f1738a1e8034404b1985c442af480155c603955/fonts/v2031 +.. _Dancing Script license: https://github.com/impallari/DancingScript/blob/7f1738a1e8034404b1985c442af480155c603955/OFL.txt +.. _Dancing Script author: https://github.com/impallari +.. _Noto Sans: https://fonts.google.com/noto/specimen/Noto+Sans +.. _Noto Project: https://github.com/notofonts/latin-greek-cyrillic +.. _Noto Sans License: https://github.com/notofonts/latin-greek-cyrillic/blob/4bc63d7ebca1faed49c6c685f380ba0abc2c1941/OFL.txt +.. _Inkscape: https://inkscape.org/ +.. _GNU GPL, version 2: https://inkscape.org/about/license/