Skip to content

Commit 5b9fa30

Browse files
vltrvltr
committed
preparing for first release; 100% code coverage (even I am impressed); documentation still needs a lot of work
1 parent 2c5a8dd commit 5b9fa30

27 files changed

+331
-294
lines changed

‎.pyup.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
schedule: every week
55
search: False
6-
branch: develop
6+
branch: master
77
requirements:
88
- requirements.txt:
99
# update all dependencies and pin them

‎CHANGELOG.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Changelog
33
=========
44

5-
v0.1.0 on 2018-0?-??
5+
v0.1.0 on 2018-10-17
66
--------------------
77

8-
* First release on PyPI. Not stable.
8+
* First release on PyPI. (Probably) not stable.

‎CONTRIBUTING.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Contributions are welcome, and they are greatly appreciated! Every little bit he
77
Bug reports
88
===========
99

10-
When `reporting a bug <https://github.com/vltr/middle-schema/issues>`_ please include:
10+
When `reporting a bug <https://github.com/vltr/sanic-boom/issues>`_ please include:
1111

1212
* Your operating system name and version.
1313
* Any details about your local setup that might be helpful in troubleshooting.
@@ -16,12 +16,12 @@ When `reporting a bug <https://github.com/vltr/middle-schema/issues>`_ please in
1616
Documentation improvements
1717
==========================
1818

19-
middle-schema could always use more documentation, whether as part of the official middle-schema docs, in docstrings, or even on the web in blog posts, articles, and such.
19+
sanic-boom could always use more documentation, whether as part of the official sanic-boom docs, in docstrings, or even on the web in blog posts, articles, and such.
2020

2121
Feature requests and feedback
2222
=============================
2323

24-
The best way to send feedback is to file an issue at https://github.com/vltr/middle-schema/issues.
24+
The best way to send feedback is to file an issue at https://github.com/vltr/sanic-boom/issues.
2525

2626
If you are proposing a feature:
2727

@@ -32,13 +32,13 @@ If you are proposing a feature:
3232
Development
3333
===========
3434

35-
To set up ``middle-schema`` for local development:
35+
To set up ``sanic-boom`` for local development:
3636

37-
1. Fork `middle-schema <https://github.com/vltr/middle-schema>`_
37+
1. Fork `sanic-boom <https://github.com/vltr/sanic-boom>`_
3838
(look for the "Fork" button).
3939
2. Clone your fork locally::
4040

41-
git clone [email protected]:your_name_here/middle-schema.git
41+
git clone [email protected]:your_name_here/sanic-boom.git
4242

4343
3. Create a branch for local development::
4444

@@ -71,7 +71,7 @@ For merging, you should:
7171
4. Add yourself to ``AUTHORS.rst``.
7272

7373
.. [1] If you don't have all the necessary python versions available locally you can rely on Travis - it will
74-
`run the tests <https://travis-ci.org/vltr/middle-schema/pull_requests>`_ for each change you add in the pull request.
74+
`run the tests <https://travis-ci.org/vltr/sanic-boom/pull_requests>`_ for each change you add in the pull request.
7575
7676
It will be slower though ...
7777

‎MANIFEST.in

+4-1
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,16 @@ exclude .travis.yml
2424
exclude .venv
2525
exclude .vscode
2626
exclude appveyor.yml
27+
exclude docs/examples
28+
exclude examples
2729
exclude Makefile
2830
exclude requirements-dev.*
2931
exclude requirements.txt
3032
exclude tox.ini
3133

3234
recursive-exclude .github *
3335
recursive-exclude .vscode *
34-
recursive-exclude benchmarks *
36+
recursive-exclude examples *
37+
recursive-exclude docs/examples *
3538

3639
global-exclude *.py[cod] __pycache__ *.so *.dylib

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ help:
1717
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
1818

1919
black:
20-
black ./src/sanic_boom/ ./tests setup.py
20+
black ./examples/ ./src/sanic_boom/ ./tests setup.py
2121

2222
cleanpycache:
2323
find . -type d | grep "__pycache__" | xargs rm -rf

‎README.rst

+8-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
=================
2-
``middle-schema``
3-
=================
1+
==============
2+
``sanic-boom``
3+
==============
44

55
.. start-badges
66
@@ -42,23 +42,15 @@
4242

4343
.. end-badges
4444
45-
Components injection, fast routing and non-global middlewares. Give your Sanic application a Boom!
45+
Components injection, fast routing and non-global (layered) middlewares. Give your Sanic application a Boom!
4646

4747
In a nutshell
4848
-------------
4949

50-
.. code-block:: pycon
51-
52-
>>> import sanic_boom
53-
54-
>>> print("hello")
55-
hello
56-
57-
>>> @enum.unique
58-
... class CityRegionEnum(str, enum.Enum):
59-
... TROPICAL = "TROPICAL"
60-
... TEMPERATE = "TEMPERATE"
61-
... BOREAL = "BOREAL"
50+
.. literalinclude:: examples/marshmallow-integration.py
51+
:language: python
52+
:emphasize-lines: 48-81
53+
:linenos:
6254

6355
.. warning::
6456

‎docs/examples

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../examples

‎docs/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
----------
44

55
.. toctree::
6-
:caption: middle-schema
6+
:caption: sanic-boom
77
:maxdepth: 1
88

99
installing

‎docs/installing.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
Installing
55
==========
66

7-
To install ``middle-schema``, use ``pip`` (or your favorite Python package manager), like::
7+
To install ``sanic-boom``, use ``pip`` (or your favorite Python package manager), like::
88

9-
pip install middle-schema
9+
pip install sanic-boom
1010

1111
And you're ready to the next step. Hooray!
1212

1313
.. warning::
1414

15-
At this time, ``middle-schema`` is only available for Python 3.5+ (and probably will be).
15+
At this time, ``sanic-boom`` is only available for Python 3.5+ (and probably will be).

‎docs/reference/sanic_boom.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
middle-schema
2-
=============
1+
sanic-boom
2+
==========
33

44
.. testsetup::
55

6-
from middle_schema import *
6+
from sanic_boom import *
77

8-
.. automodule:: middle_schema
8+
.. automodule:: sanic_boom
99
:members:

0 commit comments

Comments
 (0)