Alan Orth
64d7f1a3b2
Enable Flake8 validation in Hound CI
...
Will check all pull requests in the project to make sure they don't
violate PEP 8 style (except the E501 for long lines because I think
it makes code hard to read).
2018-11-04 00:48:06 +02:00
Alan Orth
a238a727d2
CHANGELOG.md: Add unreleased changes
2018-11-04 00:05:16 +02:00
Alan Orth
cc5ce3ab98
Correct issues highlighted by Flake8
...
Flake8 validates code style against PEP 8 in order to encourage the
writing of idiomatic Python. For reference, I am currently ignoring
errors about line length (E501) because I feel it makes code harder
to read.
This is the invocation I am using:
$ flake8 --ignore E501 dspace_statistics_api
2018-11-04 00:04:27 +02:00
Alan Orth
70dfcb93c5
dspace_statistics_api/database.py: Don't quote host in connect()
2018-11-03 22:43:05 +02:00
Alan Orth
69bcd1b5e4
CHANGELOG.md: Add unreleased changes
2018-11-03 22:42:08 +02:00
Alan Orth
5f3bd61998
Allow configuration of PostgreSQL port
...
Defaults to port 5432, but can be overridden with DATABASE_PORT.
2018-11-03 22:40:45 +02:00
Alan Orth
e54dd8888f
README.md: Update requirements
2018-11-01 16:31:36 +02:00
Alan Orth
2ba09f8693
README.md: Improve introduction
...
Obsessed with the text presentation and line length in GitHub!
2018-11-01 16:28:01 +02:00
Alan Orth
a468a87a5a
README.md: Improve introduction
2018-11-01 15:58:12 +02:00
Alan Orth
6a30b6550d
README.md: Improve introduction
2018-11-01 15:45:53 +02:00
Alan Orth
18f013bfa0
README.md: Add Falcon to introduction
2018-11-01 10:24:37 +02:00
Alan Orth
78900b5d85
CHANGELOG.md: Add changes for v0.6.1
2018-11-01 00:39:12 +02:00
Alan Orth
eb08832bf8
Sync API documentation HTML with README.md
2018-11-01 00:37:52 +02:00
Alan Orth
c2ec780ad9
README.md: Improve API documentation
2018-11-01 00:37:40 +02:00
Alan Orth
df8ebc8bf1
README.md: Improve API endpoint documentation
2018-11-01 00:31:16 +02:00
Alan Orth
0d4be5f4c8
README.md: Add API documentation endpoint
2018-11-01 00:22:16 +02:00
Alan Orth
30dc7f1939
Add basic API documentation on root (/)
...
I had imagined plugging in an interactive Swagger or OpenAPI instance
here, but that's actually much more involved in Falcon than I want to
deal with right now.
2018-11-01 00:19:39 +02:00
Alan Orth
77194707fd
README.md: Improve introduction
2018-11-01 00:08:24 +02:00
Alan Orth
10c1f8bdcc
README.md: Update Travis CI badge
2018-10-31 23:14:38 +02:00
Alan Orth
da74943da2
README.md: Update introduction
2018-10-31 22:40:36 +02:00
Alan Orth
fc8348ab29
README.md: Add acknoledgement about the Solr queries
2018-10-31 19:36:50 +02:00
Alan Orth
15c3299b99
CHANGELOG.md: Add changes for v0.6.0
2018-10-31 19:26:45 +02:00
Alan Orth
d36be5ee50
contrib: Update systemd unit files for refactor
2018-10-28 11:14:21 +02:00
Alan Orth
2f45d27554
dspace_statistics_api/app.py: remove unused code
...
This was added accidentally when I refactored. I was trying to see
if I could use Falcon's on_exit() hook.
2018-10-28 11:14:21 +02:00
Alan Orth
b8356f7a87
Add "application" alias to API object
...
By default gunicorn looks for an "application" object to run, so this
saves us having to type api:app.
2018-10-28 11:14:21 +02:00
Alan Orth
2136dc79ce
Remove shebang from indexer.py
...
This is run as a Python module now so does not need a shebang.
2018-10-28 11:14:21 +02:00
Alan Orth
ed60120cef
Remove executable bit from indexer.py
...
Now it is run as a Python module.
2018-10-28 11:14:21 +02:00
Alan Orth
c027f01b48
Refactor project structure
...
This follows guidance from several well-known Python best practices
guides. Basically, the idea is create a package for the application
that is comprised of several re-usable modules.
See: https://docs.python-guide.org/writing/structure/
See: https://realpython.com/python-application-layouts/
2018-10-28 11:14:21 +02:00
Alan Orth
754663f062
CHANGELOG.md: Add changes for version 0.5.2
2018-10-28 11:12:27 +02:00
Alan Orth
507699e58a
requirements.txt: Update libraries
...
Switch to a personal fork of SolrClient so that we can use kazoo 2.5.0
and get rid of the error about the 'async' keyword on Python 3.7. Also
this bumps some of the other libraries to their latest versions.
2018-10-28 11:09:47 +02:00
Alan Orth
a016916995
CHANGELOD.md: Add note about ujson
2018-10-24 14:15:03 +03:00
Alan Orth
6fd2827a7c
Use Python's native json instead of ujson
...
Falcon can optionally use ujson to speed up JSON (de)serialization,
but Falcon's already really fast and requiring ujson actually makes
deployment trickier in some cases (for example in Docker containers
that are based on Alpine Linux).
Here are some tests of Falcon 1.4.1 on Python 3.5 from my laptop:
1. falcon...............60172 req/sec or 16.62 μs/req (36x)
2. falcon-ext...........34186 req/sec or 29.25 μs/req (20x)
3. bottle...............32924 req/sec or 30.37 μs/req (20x)
4. werkzeug.............11948 req/sec or 83.70 μs/req (7x)
5. flask.................6654 req/sec or 150.30 μs/req (4x)
6. django................4565 req/sec or 219.04 μs/req (3x)
7. pecan.................1672 req/sec or 598.19 μs/req (1x)
The tests were conducted with Falcon's official Docker benchmarking
tools on my Intel(R) Core(TM) i7-8550U CPU @ 1.80GHz on Arch Linux.
See: https://github.com/falconry/falcon/tree/master/docker
2018-10-24 14:08:23 +03:00
Alan Orth
62142eb79e
CHANGELOG.md: Move unreleased changes to v0.5.0
2018-10-24 12:02:42 +03:00
Alan Orth
fda0321942
CHANGELOG.md: Add note about Solr in API component
2018-10-24 12:01:47 +03:00
Alan Orth
963aa245c8
app.py: Don't initialize Solr connection
...
We only need Solr in the indexing component, not for the API itself.
2018-10-24 11:59:50 +03:00
Alan Orth
568ff2eebb
CHANGELOG.md: Add note about nginx configuration
2018-10-23 14:56:44 +03:00
Alan Orth
deecb8a10b
README.md: Add example nginx configuration
2018-10-23 14:55:36 +03:00
Alan Orth
12f45d7c08
contrib: Adjust example path
2018-10-23 14:34:29 +03:00
Alan Orth
f65089f9ce
CHANGELOG.md: Update and move to 0.4.3 release
2018-10-17 09:51:44 +03:00
Alan Orth
1db5cf1c29
README.md: Grammar
2018-10-17 09:51:35 +03:00
Alan Orth
e581c4b1aa
README.md: Improve documentation
2018-10-17 09:50:30 +03:00
Alan Orth
e8d356c9ca
README.md: Add TODO about Python 3.6+ f-string syntax
...
They are faster.
2018-10-17 09:13:25 +03:00
Alan Orth
34a9b8d629
CHANGELOG.md: Add unreleased changes for Travis CI
2018-10-14 19:02:09 +03:00
Alan Orth
41e3d66a0e
.travis.yml: Only build master branch
2018-10-14 19:00:31 +03:00
Alan Orth
9b2a6137b4
README.md: Add Travis CI badge
...
For now this is only an indicator that the Python requirements can
be satisfied and installed.
2018-10-14 18:58:12 +03:00
Alan Orth
600b986f99
.travis.yml: Use Python 3.7-dev instead of 3.7
...
I don't think Travis supports Python 3.7 yet because the builds for
that version keep failing.
2018-10-14 18:57:30 +03:00
Alan Orth
49a7790794
.travis.yml: Move script to one line
2018-10-14 18:53:45 +03:00
Alan Orth
f2deba627c
.travis.yml: Run pip install as script
...
Basically for now there are no tests so I just want to just check
that requirements.txt is correct and that all dependencies can be
installed.
2018-10-14 18:47:14 +03:00
Alan Orth
9323513794
README.md: Update instructions
2018-10-14 18:45:40 +03:00
Alan Orth
daf15610f2
CHANGELOG.md: Update changes and move to 0.4.2
2018-10-05 00:19:18 +03:00