| Name | linksmith JSON |
| Version |
0.0.1
JSON |
| download |
| home_page | None |
| Summary | A program for processing Hyperlinks, Sphinx references, and inventories. |
| upload_time | 2024-04-06 14:43:11 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT License Copyright (c) 2024 Andreas Motl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
authoring
css
design
documentation
html
http
hyperlink
link
markdown
myst
referencing
restructuredtext
sphinx
swiss army knife
tech writing
toolbox
web
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Linksmith
_A program for processing Hyperlinks, Sphinx references, and inventories._
Longing for a Hyperlink, \
already in hand. \
MEP 0002, \
considering.
» [Documentation]
| [Changelog]
| [PyPI]
| [Issues]
| [Source code]
| [License]
[![CI][badge-tests]][project-tests]
[![Coverage status][badge-coverage]][project-codecov]
## What's Inside
- A few convenience wrappers around [`sphinx.ext.intersphinx`] and [sphobjinv].
- Ideas to support [DWIM]-like tooling for [Sphinx] and [Hyperlinks],
coming from a sweet conversation at pueblo's sketch about [adding an
inventory decoder for Sphinx], summarized into a [feature wish list][rfc].
- Code for community operations, alongside software tests and packaging,
in order to provide better maintainability and re-use.
> [!WARNING]
> Here be dragons. Please note the program is pre-alpha, and a work in
> progress, so everything may change while we go.
## Setup
```bash
pip install --upgrade linksmith
```
## Usage
```shell
linksmith inventory https://linksmith.readthedocs.io/en/latest/objects.inv
```
More details and other subsystems are outlined at the [Linksmith Usage]
documentation.
## Development
In order to learn how to set up a development sandbox, please visit the
[development documentation].
## Contributing
We are always happy to receive code contributions, ideas, suggestions
and problem reports from the community.
Spend some time taking a look around, locate a bug, design issue or
spelling mistake and then send us a pull request or create an issue ticket.
Thanks in advance for your efforts, we really appreciate any help or feedback.
## Acknowledgements
Kudos to [Brian Skinn], [Sviatoslav Sydorenko], [Chris Sewell], and all other
lovely people around Sphinx and Read the Docs.
## Etymology
> Anansi, or Ananse (/əˈnɑːnsi/ ə-NAHN-see) is an Akan folktale character
> associated with stories, wisdom, knowledge, and trickery.
>
> Anansi is best known for his ability to outsmart and triumph over more
> powerful opponents through his use of cunning, creativity and wit.
>
> Despite taking on a trickster role, Anansi often takes centre stage in
> stories and is commonly portrayed as both the protagonist and antagonist.
>
> -- https://en.wikipedia.org/wiki/Anansi
Another [`anansi`] package has already been published to PyPI, so we needed
to find a different name, and selected [`linksmith`] for the time being.
_If you have other suggestions as long as this program is in its infancy,
please let us know._
[adding an inventory decoder for Sphinx]: https://github.com/pyveci/pueblo/pull/73
[`anansi`]: https://pypi.org/project/anansi/
[Brian Skinn]: https://github.com/bskinn
[Chris Sewell]: https://github.com/chrisjsewell
[development documentation]: https://linksmith.readthedocs.io/en/latest/sandbox.html
[DWIM]: https://en.wikipedia.org/wiki/DWIM
[Hyperlink]: https://en.wikipedia.org/wiki/Hyperlink
[Hyperlinks]: https://en.wikipedia.org/wiki/Hyperlink
[linksmith]: https://linksmith.readthedocs.io/
[`linksmith`]: https://pypi.org/project/linksmith/
[Linksmith Usage]: https://linksmith.readthedocs.io/en/latest/usage.html
[rfc]: https://linksmith.readthedocs.io/en/latest/rfc.html
[Sphinx]: https://www.sphinx-doc.org/
[`sphinx.ext.intersphinx`]: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html
[sphobjinv]: https://sphobjinv.readthedocs.io/
[Sviatoslav Sydorenko]: https://github.com/webknjaz
[Changelog]: https://github.com/tech-writing/linksmith/blob/main/CHANGES.md
[Documentation]: https://linksmith.readthedocs.io/
[Issues]: https://github.com/tech-writing/linksmith/issues
[License]: https://github.com/tech-writing/linksmith/blob/main/LICENSE
[PyPI]: https://pypi.org/project/linksmith/
[Source code]: https://github.com/tech-writing/linksmith
[badge-coverage]: https://codecov.io/gh/tech-writing/linksmith/branch/main/graph/badge.svg
[badge-downloads-per-month]: https://pepy.tech/badge/linksmith/month
[badge-license]: https://img.shields.io/github/license/tech-writing/linksmith.svg
[badge-package-version]: https://img.shields.io/pypi/v/linksmith.svg
[badge-python-versions]: https://img.shields.io/pypi/pyversions/linksmith.svg
[badge-status]: https://img.shields.io/pypi/status/linksmith.svg
[badge-tests]: https://github.com/tech-writing/linksmith/actions/workflows/main.yml/badge.svg
[project-codecov]: https://codecov.io/gh/tech-writing/linksmith
[project-downloads]: https://pepy.tech/project/linksmith/
[project-license]: https://github.com/tech-writing/linksmith/blob/main/LICENSE
[project-pypi]: https://pypi.org/project/linksmith
[project-tests]: https://github.com/tech-writing/linksmith/actions/workflows/main.yml
Raw data
{
"_id": null,
"home_page": null,
"name": "linksmith",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "authoring, css, design, documentation, html, http, hyperlink, link, markdown, myst, referencing, restructuredtext, sphinx, swiss army knife, tech writing, toolbox, web",
"author": null,
"author_email": "Andreas Motl <andreas.motl@panodata.org>",
"download_url": "https://files.pythonhosted.org/packages/c0/7a/d1f0fd770e7b8b5946aa374bb9689c4ee2db6dd3b625e3be3aaf20f7b530/linksmith-0.0.1.tar.gz",
"platform": null,
"description": "# Linksmith\n\n_A program for processing Hyperlinks, Sphinx references, and inventories._\n\nLonging for a Hyperlink, \\\nalready in hand. \\\nMEP 0002, \\\nconsidering.\n\n\u00bb [Documentation]\n| [Changelog]\n| [PyPI]\n| [Issues]\n| [Source code]\n| [License]\n\n[![CI][badge-tests]][project-tests]\n[![Coverage status][badge-coverage]][project-codecov]\n\n\n## What's Inside\n\n- A few convenience wrappers around [`sphinx.ext.intersphinx`] and [sphobjinv].\n- Ideas to support [DWIM]-like tooling for [Sphinx] and [Hyperlinks],\n coming from a sweet conversation at pueblo's sketch about [adding an\n inventory decoder for Sphinx], summarized into a [feature wish list][rfc].\n- Code for community operations, alongside software tests and packaging,\n in order to provide better maintainability and re-use.\n\n> [!WARNING]\n> Here be dragons. Please note the program is pre-alpha, and a work in\n> progress, so everything may change while we go.\n\n\n## Setup\n\n```bash\npip install --upgrade linksmith\n```\n\n\n## Usage\n\n```shell\nlinksmith inventory https://linksmith.readthedocs.io/en/latest/objects.inv\n```\n\nMore details and other subsystems are outlined at the [Linksmith Usage]\ndocumentation.\n\n\n## Development\n\nIn order to learn how to set up a development sandbox, please visit the\n[development documentation].\n\n\n## Contributing\n\nWe are always happy to receive code contributions, ideas, suggestions\nand problem reports from the community.\n\nSpend some time taking a look around, locate a bug, design issue or\nspelling mistake and then send us a pull request or create an issue ticket.\n\nThanks in advance for your efforts, we really appreciate any help or feedback.\n\n\n## Acknowledgements\n\nKudos to [Brian Skinn], [Sviatoslav Sydorenko], [Chris Sewell], and all other\nlovely people around Sphinx and Read the Docs.\n\n\n## Etymology\n\n> Anansi, or Ananse (/\u0259\u02c8n\u0251\u02d0nsi/ \u0259-NAHN-see) is an Akan folktale character\n> associated with stories, wisdom, knowledge, and trickery.\n>\n> Anansi is best known for his ability to outsmart and triumph over more\n> powerful opponents through his use of cunning, creativity and wit.\n>\n> Despite taking on a trickster role, Anansi often takes centre stage in\n> stories and is commonly portrayed as both the protagonist and antagonist. \n>\n> -- https://en.wikipedia.org/wiki/Anansi\n\nAnother [`anansi`] package has already been published to PyPI, so we needed\nto find a different name, and selected [`linksmith`] for the time being.\n_If you have other suggestions as long as this program is in its infancy,\nplease let us know._\n\n\n[adding an inventory decoder for Sphinx]: https://github.com/pyveci/pueblo/pull/73\n[`anansi`]: https://pypi.org/project/anansi/\n[Brian Skinn]: https://github.com/bskinn\n[Chris Sewell]: https://github.com/chrisjsewell\n[development documentation]: https://linksmith.readthedocs.io/en/latest/sandbox.html\n[DWIM]: https://en.wikipedia.org/wiki/DWIM\n[Hyperlink]: https://en.wikipedia.org/wiki/Hyperlink\n[Hyperlinks]: https://en.wikipedia.org/wiki/Hyperlink\n[linksmith]: https://linksmith.readthedocs.io/\n[`linksmith`]: https://pypi.org/project/linksmith/\n[Linksmith Usage]: https://linksmith.readthedocs.io/en/latest/usage.html\n[rfc]: https://linksmith.readthedocs.io/en/latest/rfc.html\n[Sphinx]: https://www.sphinx-doc.org/\n[`sphinx.ext.intersphinx`]: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html\n[sphobjinv]: https://sphobjinv.readthedocs.io/\n[Sviatoslav Sydorenko]: https://github.com/webknjaz\n\n[Changelog]: https://github.com/tech-writing/linksmith/blob/main/CHANGES.md\n[Documentation]: https://linksmith.readthedocs.io/\n[Issues]: https://github.com/tech-writing/linksmith/issues\n[License]: https://github.com/tech-writing/linksmith/blob/main/LICENSE\n[PyPI]: https://pypi.org/project/linksmith/\n[Source code]: https://github.com/tech-writing/linksmith\n\n[badge-coverage]: https://codecov.io/gh/tech-writing/linksmith/branch/main/graph/badge.svg\n[badge-downloads-per-month]: https://pepy.tech/badge/linksmith/month\n[badge-license]: https://img.shields.io/github/license/tech-writing/linksmith.svg\n[badge-package-version]: https://img.shields.io/pypi/v/linksmith.svg\n[badge-python-versions]: https://img.shields.io/pypi/pyversions/linksmith.svg\n[badge-status]: https://img.shields.io/pypi/status/linksmith.svg\n[badge-tests]: https://github.com/tech-writing/linksmith/actions/workflows/main.yml/badge.svg\n[project-codecov]: https://codecov.io/gh/tech-writing/linksmith\n[project-downloads]: https://pepy.tech/project/linksmith/\n[project-license]: https://github.com/tech-writing/linksmith/blob/main/LICENSE\n[project-pypi]: https://pypi.org/project/linksmith\n[project-tests]: https://github.com/tech-writing/linksmith/actions/workflows/main.yml\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Andreas Motl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A program for processing Hyperlinks, Sphinx references, and inventories.",
"version": "0.0.1",
"project_urls": {
"changelog": "https://github.com/tech-writing/linksmith/blob/main/CHANGES.md",
"documentation": "https://linksmith.readthedocs.io/",
"homepage": "https://linksmith.readthedocs.io/",
"repository": "https://github.com/tech-writing/linksmith"
},
"split_keywords": [
"authoring",
" css",
" design",
" documentation",
" html",
" http",
" hyperlink",
" link",
" markdown",
" myst",
" referencing",
" restructuredtext",
" sphinx",
" swiss army knife",
" tech writing",
" toolbox",
" web"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "63bbf5219978faf3f22832aae30c5347794651f85ff78ff6307f24a0762f49cc",
"md5": "c95739d1db8a0ae8c07352745136659f",
"sha256": "2d8724aee269df9e4318e21590ee40bbf0e99438d126842b35946208efe97e4e"
},
"downloads": -1,
"filename": "linksmith-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c95739d1db8a0ae8c07352745136659f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18106,
"upload_time": "2024-04-06T14:43:09",
"upload_time_iso_8601": "2024-04-06T14:43:09.476691Z",
"url": "https://files.pythonhosted.org/packages/63/bb/f5219978faf3f22832aae30c5347794651f85ff78ff6307f24a0762f49cc/linksmith-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c07ad1f0fd770e7b8b5946aa374bb9689c4ee2db6dd3b625e3be3aaf20f7b530",
"md5": "eb21ad83c94a442b558615d7138de21a",
"sha256": "6af2a5decd8a00533899d801c562f578b66cc7e52fa6948e0a8f64ad3421f472"
},
"downloads": -1,
"filename": "linksmith-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "eb21ad83c94a442b558615d7138de21a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 23945,
"upload_time": "2024-04-06T14:43:11",
"upload_time_iso_8601": "2024-04-06T14:43:11.867915Z",
"url": "https://files.pythonhosted.org/packages/c0/7a/d1f0fd770e7b8b5946aa374bb9689c4ee2db6dd3b625e3be3aaf20f7b530/linksmith-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 14:43:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tech-writing",
"github_project": "linksmith",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "linksmith"
}
