Skip to content

v1.0 RC #38

Merged
merged 176 commits into from
Jul 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
176 commits
Select commit Hold shift + click to select a range
52061e8
Move package files to src dir
campb303 Mar 18, 2021
07ee438
Add installation instructions to readme
benne238 Mar 12, 2021
85b6f4c
Move package files to its own directory
campb303 Mar 19, 2021
0801ed9
Remove logging and update package path
campb303 Mar 19, 2021
3fa5e70
Add ability to install all conditional dependencies
campb303 Mar 19, 2021
b590473
Add docs from frontend
campb303 Mar 19, 2021
9e8802d
Remove venv-manager docs
campb303 Mar 19, 2021
a9aeef9
Add mkdocs plugin to setup
campb303 Mar 19, 2021
2fe4944
Remove symlink ref
campb303 Mar 19, 2021
38a74e3
Update README with contribution details
campb303 Mar 19, 2021
c5fcdc0
Add venv activation step to README
campb303 Mar 19, 2021
0b4c76a
mixed bad import statement in ecnqueue.md
benne238 Mar 19, 2021
2e9b148
added import statment to __init__.py to make python modules more in s…
benne238 Mar 22, 2021
26a3dff
Add easyad to requirements
campb303 Mar 22, 2021
4430d31
Fix module imports
campb303 Mar 22, 2021
e64f8a9
Change cURL config filename
campb303 Mar 22, 2021
b566910
Add check to prevent admin accounts from signing in
campb303 Mar 22, 2021
896e360
Add note about valid users
campb303 Mar 22, 2021
79c9ba4
Merge pull request #18 from ECN/create-docs-structure
campb303 Mar 24, 2021
c894551
Add variable support to mkdocs
campb303 Mar 24, 2021
b3efaf4
Update docs to include production URL variable
campb303 Mar 24, 2021
1a20353
Update auth docs to include fetch/curl examples for getting, passing …
campb303 Mar 24, 2021
0d7ccfa
style changes to the backend documentation
benne238 Mar 29, 2021
4838cac
fix for .autodoc-docstring css
benne238 Mar 29, 2021
cf7ebff
removed mentions of :private-memebers: from markdown files as autodoc…
benne238 Mar 29, 2021
f3b9d67
added additional information for the overview
benne238 Mar 29, 2021
fdf4aeb
update api.py docstrings
benne238 Mar 29, 2021
a5a185d
Remove JWT Refresh path restriction
campb303 Mar 29, 2021
1fe26c6
Create get_access_token snippet
campb303 Apr 1, 2021
f631916
Merge branch 'update-docs' of github.itap.purdue.edu:ECN/webqueue2-ap…
campb303 Apr 1, 2021
f52d74f
Replace token with include
campb303 Apr 1, 2021
858dd3b
Remove cURL examples, finish basic usage examples
campb303 Apr 2, 2021
d5f573d
Remove cURL examples, simplify javascript examples
campb303 Apr 2, 2021
28ad8a1
Simplify examples, reference mkdocs variables
campb303 Apr 2, 2021
3d6f940
Add API section to table of contents
campb303 Apr 2, 2021
f4b0b89
Remove versioning TODO
campb303 Apr 2, 2021
72c0b8b
Update GitHub link
campb303 Apr 2, 2021
eea653c
Add comment for variables
campb303 Apr 2, 2021
57452f9
Remove unnecessary file
campb303 Apr 2, 2021
e3d40b5
Minor wording changes
campb303 Apr 2, 2021
034bb2d
Create new index file
campb303 Apr 2, 2021
5fdecb5
Clean comments
campb303 Apr 2, 2021
8336ab6
Finish installation docs
campb303 Apr 2, 2021
3f3f241
Remove code formatting for URL
campb303 Apr 2, 2021
47595e1
Update repo URL
campb303 Apr 2, 2021
a6740a4
Finish Items docs
campb303 Apr 3, 2021
468b23a
Finish Queues docs
campb303 Apr 3, 2021
59aea43
Remove MkAutoDocs file
campb303 Apr 4, 2021
897a976
Remove rest operator in nav
campb303 Apr 4, 2021
e1bea81
Add endpoint docs to Item
campb303 Apr 4, 2021
52d91ef
Add enpoint docs to Queue
campb303 Apr 4, 2021
d972fd8
Remove overview doc
campb303 Apr 4, 2021
d635c86
Remove MkAutoDocs plugin
campb303 Apr 4, 2021
4e67580
Remove MkAutoDocs from MkDocs
campb303 Apr 4, 2021
5d885fa
Remove MkAutoDocs styles
campb303 Apr 4, 2021
651da82
Add basic home page
campb303 Apr 4, 2021
ecbfbd6
Merge pull request #22 from ECN/update-docs
campb303 Apr 4, 2021
80ee836
preliminary changes to the dev enviornment setup guide
benne238 May 4, 2021
da4fbb1
making docs preliminary docs
benne238 May 7, 2021
c41325c
preliminary package structure docs
benne238 May 7, 2021
a8b8eae
package structure diagram for the docs
benne238 May 7, 2021
6b9721f
migrate docstring format file from frontend
benne238 May 18, 2021
82b7e95
add dev environment to nav
benne238 May 18, 2021
c78973c
added restart to list of api commands
benne238 May 18, 2021
824a5a7
Add note admonition for tilda usage in shells
campb303 May 18, 2021
22179e8
Update ssh config ports
campb303 May 18, 2021
fd52b94
Remove unneccesary table padding
campb303 May 18, 2021
de34425
Add tip for SSH proxy jump hosts
campb303 May 18, 2021
9f3f413
Simplify extensions list
campb303 May 18, 2021
485de8a
Add more details about virtual environment setup
campb303 May 18, 2021
1fddf8e
Correct and simplify API commands
campb303 May 18, 2021
072397e
Merge pull request #29 from ECN/update-dev-environment-setup-guide
benne238 May 18, 2021
4e47118
Create Item module in webqueue2api package
campb303 May 28, 2021
98d0544
Create Queue module in webqueue2api package
campb303 May 28, 2021
2ed1489
Move isValidItemName func to Utilities module
campb303 Jun 1, 2021
7972440
Move Item and Queue classes to parser subpackage
campb303 Jun 2, 2021
45813b6
Add getValidQueues function to parser utilities
campb303 Jun 2, 2021
487f9df
Add getQueueCounts and loadQueues functions to utilities
campb303 Jun 2, 2021
6786acf
Move utility functions to queue module
campb303 Jun 7, 2021
77d286f
Add section comments to item module
campb303 Jun 7, 2021
92f7377
Refine exports
campb303 Jun 7, 2021
f060381
Simplify import statement
campb303 Jun 9, 2021
e3164aa
Remove logging and allow packages installed from src directory
campb303 Jun 9, 2021
9f545fe
Create config module for parser package
campb303 Jun 10, 2021
b67ee91
Replace hardcoded config in Item with package config value
campb303 Jun 10, 2021
b834d86
Add queues_to_ignore to parser config
campb303 Jun 10, 2021
4685c30
Replace hardcoded config in Queue with package config value
campb303 Jun 10, 2021
7234882
Correct parser config class
campb303 Jun 10, 2021
3aca5fe
Export parser package config
campb303 Jun 10, 2021
57de1c5
Create webqueue2api package config
campb303 Jun 10, 2021
d1682ca
Export webqueue2api package config
campb303 Jun 10, 2021
5d09a1d
Add dataclasses library to setup file
campb303 Jun 10, 2021
90abd36
Create api sub-package skeleton with blank config
campb303 Jun 15, 2021
c17647d
Add api config to webqueue2api config
campb303 Jun 15, 2021
0d38b4f
Add generate_random_string function to API config
campb303 Jun 16, 2021
b452e15
Add jwt_secret_key and environment options to api config with defaults
campb303 Jun 16, 2021
cae26be
Create app module in api package with Flask config
campb303 Jun 16, 2021
a7c325f
create resources package
campb303 Jun 16, 2021
a4a669b
Create auth module in api package and add user_is_valid function
campb303 Jun 16, 2021
86ec831
Create login resource
campb303 Jun 16, 2021
b50ce98
Add login resource to api at /api/login
campb303 Jun 16, 2021
146a192
Export app in api package
campb303 Jun 16, 2021
6810fde
Add docstring to parser config
campb303 Jun 16, 2021
544375a
Create RefreshAccessToken resource
campb303 Jun 16, 2021
9b95871
Export RefreshAccessToken from resources
campb303 Jun 16, 2021
a32b46e
Add RefreshAccessToken resource to /api/token/refresh endpoint
campb303 Jun 16, 2021
107828a
Convert item path from string to Path object
campb303 Jun 16, 2021
7e966e9
Create parser errors module and add ItemDoesNotExistError
campb303 Jun 16, 2021
afecc47
Raise ItemDoesNotExistError if Item is not found
campb303 Jun 16, 2021
9e4c10d
Create ItemResource resource
campb303 Jun 16, 2021
48f3795
Export ItemResource from resources
campb303 Jun 16, 2021
90a67cb
Add ItemResource to /api/data/ path
campb303 Jun 16, 2021
10de49f
Import parser.Item as _Item and rename ItemResource to Item
campb303 Jun 16, 2021
f9713fe
Re-enable authentication
campb303 Jun 17, 2021
08748d9
Create QueueDoesNotExistError
campb303 Jun 17, 2021
ab40762
Replace self.__directory with Path object and raise QueueDoesNotExist…
campb303 Jun 17, 2021
ff13266
Change self.__directory to self.path
campb303 Jun 17, 2021
89e3ef1
Rename self._getItems to self.get_items
campb303 Jun 17, 2021
3846d2d
Refactor to snake case
campb303 Jun 17, 2021
daf5b98
Update imports from parser.Queue
campb303 Jun 17, 2021
1469b01
Create Queue resource with error handling
campb303 Jun 17, 2021
7a1c7b8
Export Queue from resources
campb303 Jun 17, 2021
20bdc00
Add Queue resource to /api/data/queue path
campb303 Jun 17, 2021
b8a53e1
Update docstring and rename jsonData/toJson to json_data/to_json
campb303 Jun 17, 2021
1d878b3
Update Queue.to_json reference
campb303 Jun 17, 2021
6dcab81
Refactor params to snake_case and update docstring
campb303 Jun 17, 2021
840931c
Refactor Item module to snake case
campb303 Jun 21, 2021
e85592b
Refactored to snake case
campb303 Jun 21, 2021
c82240c
Create QueueList resource
campb303 Jun 21, 2021
30be281
Export QueueList resource
campb303 Jun 21, 2021
74c7453
Export get_queue_counts for QueueList resource
campb303 Jun 21, 2021
82ac80a
Add QueueList resource to API
campb303 Jun 21, 2021
48a4d17
Delete old modules
campb303 Jun 21, 2021
17e60e7
Remove unnecceary __init__=
campb303 Jun 21, 2021
f8cf5b8
Re-enable authentication for Item in API
campb303 Jun 21, 2021
13a4093
Fix broken reference
campb303 Jun 21, 2021
a171acc
Add docstring format
campb303 Jun 21, 2021
c4e8532
Auto populate Item.json_data
campb303 Jun 21, 2021
b72ae74
Correct mis-spelled parse_eaders to parse_headers and added header on…
campb303 Jun 21, 2021
48318ac
Correct docstring
campb303 Jun 21, 2021
51bddfa
Add headers only loading to Queue
campb303 Jun 21, 2021
fb8b46e
Add headers_only query string parsing to Item resource
campb303 Jun 21, 2021
83be4a2
Add headers_only query string parsing to Queue resource
campb303 Jun 21, 2021
3a87891
Automate generation of json_data in Queue module
campb303 Jun 21, 2021
ef7104d
Re-enable authentication
campb303 Jun 21, 2021
3762076
Merge branch 'refactor-to-module-layout' into staging
campb303 Jun 21, 2021
aac0bb8
Change server port from 8000 to 6060
campb303 Jun 21, 2021
26e7938
Add mkdocs-macros-plugin to dependencies
campb303 Jun 21, 2021
ca58cc1
Update Dev Environment Setup Guide
campb303 Jun 21, 2021
60168f4
Remove stub doc
campb303 Jun 21, 2021
2b026ee
Update Item endpoint and params docs
campb303 Jun 21, 2021
15a6697
Update Queue endpoint and params docs
campb303 Jun 21, 2021
158dabd
Update docstring
campb303 Jun 21, 2021
b08d79d
Update item.py
campb303 Jun 29, 2021
8baa833
Merge pull request #34 from ECN/update-item-repr
campb303 Jun 29, 2021
7d91019
Remove old module files
campb303 Jun 29, 2021
981a973
Add 500 return code to docstring
campb303 Jun 29, 2021
5607d12
Add 500 return code to docstring
campb303 Jun 29, 2021
56d4ba8
Add 500 error code to docstring
campb303 Jun 29, 2021
e9f0a14
Add 500 error code to docstring
campb303 Jun 29, 2021
9af4296
Add docstring to RefreshAccessToken resource
campb303 Jun 29, 2021
076a5b2
Add type info to Item attributes
campb303 Jun 29, 2021
ed5f48e
Correct Item.json_data type in docstring
campb303 Jun 29, 2021
0e8b1dc
Update Item.__get_time_last_updated docstring to reflect ISO 8601 formt
campb303 Jun 29, 2021
3408d37
Add output example to Queue.__generate_json_data docstring
campb303 Jun 29, 2021
13d1e27
Remove non-existent arg from is_valid_item_name function
campb303 Jun 29, 2021
04654f8
Moved docs source files from docs/ to docs-src/ for GitHub pages
campb303 Jun 29, 2021
9078083
Move MkDocs src and build directories for GitHub pages
campb303 Jun 29, 2021
57abb05
Remove unused package structure docs
campb303 Jun 29, 2021
f9a8616
Add webqueue2api Package Getting Started docs
campb303 Jun 29, 2021
ed870f8
Add virtual environment and how to run notes
campb303 Jun 30, 2021
b005765
Move Installation docs to top level
campb303 Jun 30, 2021
93f1a13
Update installation link
campb303 Jun 30, 2021
aa145e1
Create webqueue2api Package section and Getting Started docs
campb303 Jun 30, 2021
14e9148
Add Package Structure docs and configuration usage example
campb303 Jul 1, 2021
3917396
Add mkautodocs plugins
campb303 Jul 1, 2021
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,6 @@ instance/
# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

Expand Down Expand Up @@ -121,7 +118,7 @@ venv.bak/
.ropeproject

# mkdocs documentation
/site
/docs

# mypy
.mypy_cache/
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,22 @@ For example, to install version 0.9.1:
```
git+https://github.itap.purdue.edu/ECN/webqueue2-api@0.9.1#egg=webqueue2-api
```

## Contributing
1. Clone the git repo:
```bash
git clone https://github.itap.purdue.edu/ECN/webqueue2-api.git
```
2. Create and activate Python virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate
```
3. Install dependencies:
```bash
# Older versions of pip may fail to install newer packages.
pip install -U pip
# Install the webqueue2-api package in editable mode with all extra packages.
pip install -e .[all]
```
4. Make changes and create a PR.
Empty file removed __init__.py
Empty file.
248 changes: 0 additions & 248 deletions api.py

This file was deleted.

Loading