Skip to content

Commit

Permalink
docs: updated sphinx, readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akimrx committed Mar 26, 2024
1 parent 5005c84 commit daf20fc
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ This library is a simple client for working with **[Yandex Lockbox](https://clou

**In the near future release:**

- [x] Tests
- [ ] Async client implementation
- [ ] Implement access bindings methods and view operations
- [ ] Tests
- [ ] Ansible action and lookup plugins


## Install

Installing with PIP:
Installing via [pip](https://pypi.org/project/yc-lockbox/):

```
pip install yc-lockbox
Expand Down
13 changes: 13 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Yandex Lockbox Python client documentation

Release v\ |release|

.. image:: https://img.shields.io/pypi/pyversions/yc-lockbox.svg
:target: https://pypi.org/project/yc-lockbox/

.. image:: https://img.shields.io/pypi/v/yc-lockbox.svg
:target: https://pypi.org/project/yc-lockbox/

.. image:: https://codecov.io/gh/akimrx/python-yc-lockbox/branch/master/graph/badge.svg
:target: https://github.com/akimrx/python-yc-lockbox

.. image:: https://github.com/akimrx/python-yc-lockbox/workflows/Tests/badge.svg
:target: https://github.com/akimrx/python-yc-lockbox


This library is a simple client for working with `Yandex Lockbox <https://cloud.yandex.ru/en/docs/lockbox/>`_ over `REST API <https://cloud.yandex.ru/en/docs/lockbox/api-ref/>`_, simplifying work with secrets and allowing you to work with them in the OOP paradigm.

------------------------------
Expand Down
4 changes: 4 additions & 0 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,10 @@
<section id="yandex-lockbox-python-client-documentation">
<h1>Yandex Lockbox Python client documentation<a class="headerlink" href="#yandex-lockbox-python-client-documentation" title="Link to this heading">#</a></h1>
<p>Release v0.1.3</p>
<a class="reference external image-reference" href="https://pypi.org/project/yc-lockbox/"><img alt="https://img.shields.io/pypi/pyversions/yc-lockbox.svg" src="https://img.shields.io/pypi/pyversions/yc-lockbox.svg" /></a>
<a class="reference external image-reference" href="https://pypi.org/project/yc-lockbox/"><img alt="https://img.shields.io/pypi/v/yc-lockbox.svg" src="https://img.shields.io/pypi/v/yc-lockbox.svg" /></a>
<a class="reference external image-reference" href="https://github.com/akimrx/python-yc-lockbox"><img alt="https://codecov.io/gh/akimrx/python-yc-lockbox/branch/master/graph/badge.svg" src="https://codecov.io/gh/akimrx/python-yc-lockbox/branch/master/graph/badge.svg" /></a>
<a class="reference external image-reference" href="https://github.com/akimrx/python-yc-lockbox"><img alt="https://github.com/akimrx/python-yc-lockbox/workflows/Tests/badge.svg" src="https://github.com/akimrx/python-yc-lockbox/workflows/Tests/badge.svg" /></a>
<p>This library is a simple client for working with <a class="reference external" href="https://cloud.yandex.ru/en/docs/lockbox/">Yandex Lockbox</a> over <a class="reference external" href="https://cloud.yandex.ru/en/docs/lockbox/api-ref/">REST API</a>, simplifying work with secrets and allowing you to work with them in the OOP paradigm.</p>
<hr class="docutils" />
<p><strong>Supported Python versions</strong>:</p>
Expand Down
13 changes: 13 additions & 0 deletions docs_src/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ Yandex Lockbox Python client documentation

Release v\ |release|

.. image:: https://img.shields.io/pypi/pyversions/yc-lockbox.svg
:target: https://pypi.org/project/yc-lockbox/

.. image:: https://img.shields.io/pypi/v/yc-lockbox.svg
:target: https://pypi.org/project/yc-lockbox/

.. image:: https://codecov.io/gh/akimrx/python-yc-lockbox/branch/master/graph/badge.svg
:target: https://github.com/akimrx/python-yc-lockbox

.. image:: https://github.com/akimrx/python-yc-lockbox/workflows/Tests/badge.svg
:target: https://github.com/akimrx/python-yc-lockbox


This library is a simple client for working with `Yandex Lockbox <https://cloud.yandex.ru/en/docs/lockbox/>`_ over `REST API <https://cloud.yandex.ru/en/docs/lockbox/api-ref/>`_, simplifying work with secrets and allowing you to work with them in the OOP paradigm.

------------------------------
Expand Down

0 comments on commit daf20fc

Please sign in to comment.