chore: rst -> md
This commit is contained in:
parent
0d14c01d0e
commit
2e8c254f3f
GPG Key ID:
03789458B3D0C410
|
|
@ -0,0 +1,5 @@
|
|||
# Flask_Calibrestekje 0.0.1 (2020-03-01)
|
||||
|
||||
## Project announcements
|
||||
|
||||
- Initial release is out! (#1)
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
Flask_Calibrestekje 0.0.1 (2020-03-01)
|
||||
======================================
|
||||
|
||||
Project announcements
|
||||
---------------------
|
||||
|
||||
- Initial release is out! (#1)
|
||||
|
|
@ -1,111 +0,0 @@
|
|||
Introduction
|
||||
------------
|
||||
|
||||
The flask-calibrestekje community is committed to providing an inclusive, safe,
|
||||
and collaborative environment for all participants, regardless of their gender,
|
||||
gender expression, race, ethnicity, religion, sexual orientation, sexual
|
||||
characteristics, physical appearance, disability, or age. We encourage every
|
||||
participant to be themselves, and must respect the rights of others. The code
|
||||
of conduct is a set of guidelines that establishes shared values and ensures
|
||||
that behaviors that may harm participants are avoided.
|
||||
|
||||
The values of the flask-calibrestekje community are focused on developing both
|
||||
our individual and collective potential, supporting and empowering the most
|
||||
marginalized, mutual respect, and an anti-violence approach that favors support
|
||||
and collaboration among participants and the resolution of conflicts. A code of
|
||||
conduct helps us co-exist in a more positive way and provides individuals who
|
||||
are victims of negative behaviors with confidence that they will be supported
|
||||
by the organization and the Flask-calibrestekje community, who respects and
|
||||
stands behind the code of conduct.
|
||||
|
||||
The flask-calibrestekje community works towards providing a welcoming
|
||||
environment where participants are treated with dignity and respect and are
|
||||
free to be themselves. We encourage all participants to approach the
|
||||
Flask-calibrestekje network with an open and positive attitude, engaging
|
||||
constructively with others at all times.
|
||||
|
||||
Respect for Diversity & Inclusion
|
||||
---------------------------------
|
||||
|
||||
We avoid comments, actions or propaganda that encourage discrimination related
|
||||
to gender, gender expression, race, ethnicity, religion, sexual orientation,
|
||||
sexual characteristics, physical appearance, disability, or age.
|
||||
|
||||
Respect Freedom of Expression
|
||||
-----------------------------
|
||||
|
||||
We support an individual's freedom of expression, and will not make fun of
|
||||
accents or make unsolicited grammatical corrections. We will strive to better
|
||||
understand each other by not assuming experiences or beliefs, clarifying
|
||||
meanings, and making an effort to speak clearly, avoiding jargon and acronyms.
|
||||
|
||||
Commitment to Non-Violence
|
||||
--------------------------
|
||||
|
||||
We will not engage in any type of violence or aggression, including verbal
|
||||
threats or complaints, intimidation, stalking or harassment, whether physically
|
||||
or psychologically.
|
||||
|
||||
Rejection of Sexual Harassment
|
||||
------------------------------
|
||||
|
||||
We understand sexual harassment as unwanted physical contact or insinuation of
|
||||
a sexual nature, as well as displaying images, drawings or visual
|
||||
representations of any kind that objectify members of any gender or reinforce
|
||||
oppression. The only exception is if this is part of a session, workshop and/or
|
||||
educational experience where showing these images is educational in nature.
|
||||
|
||||
Respect for Privacy
|
||||
-------------------
|
||||
|
||||
We safeguard the privacy of the participants. This includes refraining from
|
||||
posting or publishing information about attendees (including names and
|
||||
affiliation) unless given clear permission, and avoid any type of unauthorized
|
||||
video, audio recording, or photography.
|
||||
|
||||
Facilitate Participation & Collaboration
|
||||
----------------------------------------
|
||||
|
||||
We work to create an environment that facilitates participation for all
|
||||
participants. We will not engage in sustained disruption of discussions or
|
||||
events, interrupt conversations in a way that negatively impacts collaboration,
|
||||
or engage in toxic behaviours to attract negative attention to a participant.
|
||||
|
||||
We Care about the Integrity and Health of the Community
|
||||
-------------------------------------------------------
|
||||
|
||||
We value the health of the community and will not engage in behaviour that can
|
||||
negatively impact it. This includes contaminating food or drink with drugs, or
|
||||
inciting or insisting on the consumption of alcohol, psychoactive substances,
|
||||
etc.
|
||||
|
||||
Support Positive Interactions Among Participants
|
||||
------------------------------------------------
|
||||
|
||||
We are committed to engaging constructively with others at all times. We will
|
||||
not tolerate bullying, including requesting or mobilizing others, either in
|
||||
person or online, to bully others.
|
||||
|
||||
Enforcement
|
||||
-----------
|
||||
|
||||
Overseeing the code of conduct
|
||||
==============================
|
||||
|
||||
The flask-calibrestekje community, composed of volunteers, oversees the code of
|
||||
conduct, including addressing all incident reports. Breaking the code of
|
||||
conduct may result in immediate expulsion from the flask-calibrestekje network.
|
||||
|
||||
How to Report an Incident
|
||||
=========================
|
||||
|
||||
If you witness an incident or are the victim of one:
|
||||
|
||||
1. You can reach out directly via email at lukewm@riseup.net.
|
||||
|
||||
Acknowledgements
|
||||
----------------
|
||||
|
||||
This code of conduct is inspired by the `IFF CoC`_.
|
||||
|
||||
.. _IFF CoC: https://www.internetfreedomfestival.org/wiki/index.php/Code_of_Conduct
|
||||
|
|
@ -0,0 +1,60 @@
|
|||
# Get started
|
||||
|
||||
Install [Tox](http://tox.readthedocs.io/).
|
||||
|
||||
# Run tests
|
||||
|
||||
``` bash
|
||||
$ tox -e test
|
||||
```
|
||||
|
||||
# Lint source
|
||||
|
||||
``` bash
|
||||
$ tox -e lint
|
||||
```
|
||||
|
||||
# Format source
|
||||
|
||||
``` bash
|
||||
$ tox -e format
|
||||
```
|
||||
|
||||
# Type check source
|
||||
|
||||
``` bash
|
||||
$ tox -e type
|
||||
```
|
||||
|
||||
# Build the documentation
|
||||
|
||||
``` bash
|
||||
$ tox -e docs
|
||||
$ tox -e docs-livereload
|
||||
```
|
||||
|
||||
# Make a new release
|
||||
|
||||
Ensure metadata for packaging is correct.
|
||||
|
||||
``` bash
|
||||
$ tox -e metadata-release
|
||||
```
|
||||
|
||||
Generate the changelog with the next target version.
|
||||
|
||||
``` bash
|
||||
$ export VERSION=1.0.1 tox -e changelog
|
||||
```
|
||||
|
||||
Make a new Git tag.
|
||||
|
||||
``` bash
|
||||
$ git tag -a 1.0.1
|
||||
```
|
||||
|
||||
And finally, make a new release.
|
||||
|
||||
``` bash
|
||||
$ tox -e release
|
||||
```
|
||||
|
|
@ -1,70 +0,0 @@
|
|||
Get started
|
||||
-----------
|
||||
|
||||
Install `Tox`_.
|
||||
|
||||
.. _tox: http://tox.readthedocs.io/
|
||||
|
||||
Run tests
|
||||
---------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e test
|
||||
|
||||
Lint source
|
||||
-----------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e lint
|
||||
|
||||
Format source
|
||||
-------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e format
|
||||
|
||||
Type check source
|
||||
-----------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e type
|
||||
|
||||
Build the documentation
|
||||
-----------------------
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e docs
|
||||
$ tox -e docs-livereload
|
||||
|
||||
|
||||
Make a new release
|
||||
------------------
|
||||
|
||||
Ensure metadata for packaging is correct.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e metadata-release
|
||||
|
||||
Generate the changelog with the next target version.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ export VERSION=1.0.1 tox -e changelog
|
||||
|
||||
Make a new Git tag.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ git tag -a 1.0.1
|
||||
|
||||
And finally, make a new release.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ tox -e release
|
||||
|
|
@ -1 +1 @@
|
|||
include LICENSE README.rst CHANGELOG.rst
|
||||
include LICENSE README.md CHANGELOG.md
|
||||
|
|
|
|||
|
|
@ -0,0 +1,45 @@
|
|||
# flask-calibrestekje {#header}
|
||||
|
||||
[](LICENSE)
|
||||
[](https://badge.fury.io/py/flask-calibrestekje)
|
||||
[](https://travis-ci.com/decentral1se/flask-calibrestekje)
|
||||
[](https://calibrestekje.readthedocs.io/en/latest/)
|
||||
[](https://liberapay.com/decentral1se)
|
||||
|
||||
## Library prototyping based on Calibre with Flask
|
||||
|
||||
### Example
|
||||
|
||||
#### app.cfg
|
||||
|
||||
``` cfg
|
||||
CALIBRESTEKJE_SQLITE_URL = "sqlite:///mymetadata.db"
|
||||
```
|
||||
|
||||
#### app.py
|
||||
|
||||
``` python
|
||||
from calibrestekje import Book
|
||||
from flask import Flask, jsonify
|
||||
|
||||
from flask_calibrestekje import CalibreStekje
|
||||
|
||||
app = Flask(__name__)
|
||||
app.config.from_pyfile("app.cfg")
|
||||
db = CalibreStekje(app)
|
||||
|
||||
@app.route("/")
|
||||
def home():
|
||||
return jsonify({"book-count": db.session.query(Book).count()})
|
||||
```
|
||||
|
||||
#### command-line
|
||||
|
||||
``` bash
|
||||
$ export FLASK_APP=app.py
|
||||
$ flask run
|
||||
```
|
||||
|
||||
### Documentation
|
||||
|
||||
- <https://calibrestekje.readthedocs.io/>
|
||||
82
README.rst
82
README.rst
|
|
@ -1,82 +0,0 @@
|
|||
.. _header:
|
||||
|
||||
*******************
|
||||
flask-calibrestekje
|
||||
*******************
|
||||
|
||||
.. image:: https://img.shields.io/badge/license-GPL-brightgreen.svg
|
||||
:target: LICENSE
|
||||
:alt: Repository license
|
||||
|
||||
.. image:: https://badge.fury.io/py/flask-calibrestekje.svg
|
||||
:target: https://badge.fury.io/py/flask-calibrestekje
|
||||
:alt: PyPI package
|
||||
|
||||
.. image:: https://travis-ci.com/decentral1se/flask-calibrestekje.svg?branch=master
|
||||
:target: https://travis-ci.com/decentral1se/flask-calibrestekje
|
||||
:alt: Travis CI result
|
||||
|
||||
.. image:: https://readthedocs.org/projects/calibrestekje/badge/?version=latest
|
||||
:target: https://calibrestekje.readthedocs.io/en/latest/
|
||||
:alt: Documentation status
|
||||
|
||||
.. image:: http://img.shields.io/liberapay/patrons/decentral1se.svg?logo=liberapay
|
||||
:target: https://liberapay.com/decentral1se
|
||||
:alt: Support badge
|
||||
|
||||
.. _introduction:
|
||||
|
||||
Library prototyping based on Calibre with Flask
|
||||
-----------------------------------------------
|
||||
|
||||
.. _example:
|
||||
|
||||
Example
|
||||
*******
|
||||
|
||||
app.cfg
|
||||
=======
|
||||
|
||||
.. code-block:: cfg
|
||||
|
||||
CALIBRESTEKJE_SQLITE_URL = "sqlite:///mymetadata.db"
|
||||
|
||||
app.py
|
||||
======
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from calibrestekje import Book
|
||||
from flask import Flask, jsonify
|
||||
|
||||
from flask_calibrestekje import CalibreStekje
|
||||
|
||||
app = Flask(__name__)
|
||||
app.config.from_pyfile("app.cfg")
|
||||
db = CalibreStekje(app)
|
||||
|
||||
@app.route("/")
|
||||
def home():
|
||||
return jsonify({"book-count": db.session.query(Book).count()})
|
||||
|
||||
command-line
|
||||
============
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ export FLASK_APP=app.py
|
||||
$ flask run
|
||||
|
||||
.. _documentation:
|
||||
|
||||
Documentation
|
||||
*************
|
||||
|
||||
* https://calibrestekje.readthedocs.io/
|
||||
|
||||
Mirroring
|
||||
*********
|
||||
|
||||
* `hack.decentral1.se/decentral1se/flask-calibrestekje`_
|
||||
|
||||
.. _hack.decentral1.se/decentral1se/flask-calibrestekje: https://hack.decentral1.se/decentral1se/flask-calibrestekje/
|
||||
|
|
@ -13,7 +13,7 @@ include = '\.pyi?$'
|
|||
|
||||
[tool.towncrier]
|
||||
directory = "changelog/"
|
||||
filename = "CHANGELOG.rst"
|
||||
filename = "CHANGELOG.md"
|
||||
package = "flask_calibrestekje"
|
||||
package_dir = "flask_calibrestekje"
|
||||
|
||||
|
|
|
|||
10
setup.cfg
10
setup.cfg
|
|
@ -15,16 +15,16 @@ include_trailing_comma = True
|
|||
[metadata]
|
||||
name = flask-calibrestekje
|
||||
author = decentral1se
|
||||
author_email = lukewm@riseup.net
|
||||
author_email = cellarspoon@riseup.net
|
||||
maintainer = decentral1se
|
||||
maintainer_email = lukewm@riseup.net
|
||||
url = https://github.com/decentral1se/flask-calibrestekje
|
||||
maintainer_email = cellarspoon@riseup.net
|
||||
url = https://git.coopcloud.tech/decentral1se/flask-calibrestekje
|
||||
project_urls =
|
||||
Source Code = https://github.com/decentral1se/flask-calibrestekje
|
||||
Source Code = https://git.coopcloud.tech/decentral1se/flask-calibrestekje
|
||||
Documentation = https://flask-calibrestekje.readthedocs.io/
|
||||
Maintainer Support = https://liberapay.come/decentral1se
|
||||
description = Library prototyping based on Calibre with Flask
|
||||
long_description = file: README.rst
|
||||
long_description = file: README.md
|
||||
license = GPLv3
|
||||
license_file = LICENSE
|
||||
classifiers =
|
||||
|
|
|
|||
Loading…
Reference in New Issue