Alan Orth
c1c2e319ac
README.md: Rework to use pip instead of pipenv
...
Pipenv is great for local development, but I don't think many people
are using it yet. I can use it locally and on Travis, but still keep
vanilla requirements.txt for use with pip. The requirements.txt file
can be generated easily from pipenv itself:
$ pipenv lock -r > requirements.txt
The same for the development requirements:
$ pipenv lock -r -d > requirements-dev.txt
2018-11-12 08:49:02 +02:00
Alan Orth
e25c974796
README.md: We have tests now
2018-11-11 17:08:51 +02:00
Alan Orth
140cc4cb07
README.md: Remove TODO for database try/except
...
Now database connection errors are properly excepted and raised.
2018-11-11 00:04:28 +02:00
Alan Orth
b06c82bb16
README.md: Remove TODO about closing database connection
...
Now I'm using a database manager class with Python's "with" context
blocks to automatically and concisely open and close connections.
2018-11-07 17:47:59 +02:00
Alan Orth
888f85d19e
README.md: Adjust installation for pipenv
...
It's nicer to manager module versions using pipenv, and I can still
generate a requirements.txt for deploying the exact versions on the
production server.
2018-11-04 16:07:27 +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
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
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
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
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
deecb8a10b
README.md: Add example nginx configuration
2018-10-23 14:55:36 +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
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
9323513794
README.md: Update instructions
2018-10-14 18:45:40 +03:00
Alan Orth
3580473a6d
README.md: Add TODO about JSON in PostgreSQL
2018-10-03 20:08:18 +03:00
Alan Orth
071c24535f
README.md: Add TODO about API versions
2018-10-03 11:12:18 +03:00
Alan Orth
4291aecac4
README.md: Formatting
2018-09-27 12:45:15 +03:00
Alan Orth
c68ddacaa4
README.md: Add note about systemd units for deployment
2018-09-27 09:26:47 +03:00
Alan Orth
9c9e79769e
README.md: Add TODO
2018-09-27 09:17:45 +03:00
Alan Orth
2ad5ade556
README.md: Improve introduction
2018-09-27 09:12:52 +03:00
Alan Orth
7412a09670
README.md: Improve introduction
2018-09-27 09:07:28 +03:00
Alan Orth
bb744a00b8
README.md: Add requirements
2018-09-27 08:57:27 +03:00
Alan Orth
560fa6056d
README.md: Remove batch inserts from TODO
2018-09-26 23:25:35 +03:00
Alan Orth
366ae25b8e
README.md: Add link to psycopg2 issue about batch inserts
2018-09-26 22:23:08 +03:00
Alan Orth
0f3054ae03
README.md: Add TODO about batch DB inserts
2018-09-26 16:31:13 +03:00
Alan Orth
2850035a4c
Return HTTP 404 when an item id is not found
2018-09-25 13:12:53 +03:00
Alan Orth
c0b550109a
README.md: Improve wording
2018-09-25 12:24:52 +03:00
Alan Orth
f7c7390e4f
README.md: Add note about Python 3.7
2018-09-25 12:07:58 +03:00
Alan Orth
4cf8656b35
Change / route to /items
...
I think it's more obvious if the "all items" route is plural. Also,
this will allow me to eventually put documentation at the root.
2018-09-25 11:34:07 +03:00
Alan Orth
f30a464cd1
README.md: Add notes about API endpoints
2018-09-25 11:28:12 +03:00
Alan Orth
93ae12e313
README.md: Update introduction
2018-09-25 11:15:12 +03:00
Alan Orth
46a1476ab0
Add requirements.txt
...
Generated with `pip freeze`. This is so I can pin the versions of
packages that I've tested with as well as to allow Travis to test
whether the project runs on various Pythons and to let GitHub in-
form me of vulnerabilities in some libraries.
2018-09-25 11:02:50 +03:00
Alan Orth
3327884f21
Update docs to remove SQLite stuff
...
I've decided to use PostgreSQL instead of SQLite because the UPSERT
support is available in versions of PostgreSQL we're alread running,
whereas SQLite needs a VERY new (3.24.0) version that is not avail-
able on any recent long-term support Ubuntu releases.
2018-09-25 00:56:01 +03:00
Alan Orth
28d61fb041
README.md: Add notes about Python and SQLite versions
2018-09-24 17:26:48 +03:00
Alan Orth
6c28be0463
README.md: Add note about route for all items
2018-09-24 16:13:26 +03:00
Alan Orth
2d8d1e6833
README.md: Add TODO for nonexistent items
2018-09-24 00:48:02 +03:00
Alan Orth
e26e595ea1
README.md: Add more TODOs
2018-09-24 00:35:00 +03:00
Alan Orth
e1b9d1284f
Rename project to DSpace Statistics API
...
At first I called it "CGSpace" because I was making it specifically
for our CGSpace DSpace repository, but the potential here is bigger
than that!
2018-09-23 23:02:21 +03:00
Alan Orth
4e8621e3d9
README.md: Add TODO about API documentation
2018-09-23 09:52:36 +03:00