Skip to content
Jump to bottom

v1.0 RC #38

Merged
merged 176 commits into from
Jul 1, 2021
Merged

v1.0 RC #38

merged 176 commits into from
Jul 1, 2021

Conversation

campb303
Copy link
Collaborator

@campb303 campb303 commented Jul 1, 2021

Changelog

1.0

  • Restructured package layout
  • Add global package configurations via dataclasses
  • Added QueueDoesNotExist and ItemDoesNotExist exceptions to parser
  • Standardized snake_case formatting
  • Changed MkDocs ports from 8000 to 6060
  • Add ability to install conditional depencies for production (default), docs, dev and a metapackage called all.
  • Dropped cURL examples from documentation
  • Prevent accounts ending with adm from logging into the API
  • Started using variables in documentation via Macro plugin

campb303 and others added 30 commits March 18, 2021 15:39
@campb303
Move package files to src dir
52061e8
@benne238 @campb303
Add installation instructions to readme
07ee438
@campb303
Move package files to its own directory
85b6f4c
@campb303
Remove logging and update package path
0801ed9
@campb303
Add ability to install all conditional dependencies
3fa5e70
@campb303
Add docs from frontend
b590473
@campb303
Remove venv-manager docs
9e8802d
@campb303
Add mkdocs plugin to setup
a9aeef9
@campb303
Remove symlink ref
2fe4944
@campb303
Update README with contribution details
38a74e3
@campb303
Add venv activation step to README
c5fcdc0
@benne238
mixed bad import statement in ecnqueue.md
0b4c76a
@benne238
added import statment to __init__.py to make python modules more in s…
2e9b148 
…cripts importing webqueue2_api package
@campb303
Add easyad to requirements
26a3dff
@campb303
Fix module imports
4430d31
@campb303
Change cURL config filename
e64f8a9
@campb303
Add check to prevent admin accounts from signing in
b566910
@campb303
Add note about valid users
896e360
@campb303
Merge pull request #18 from ECN/create-docs-structure
79c9ba4 
Create docs structure
@campb303
Add variable support to mkdocs
c894551
@campb303
Update docs to include production URL variable
b3efaf4
@campb303
Update auth docs to include fetch/curl examples for getting, passing …
1a20353 
…and refreshing tokens
@benne238
style changes to the backend documentation
0d7ccfa
@benne238
fix for .autodoc-docstring css
4838cac
@benne238
removed mentions of :private-memebers: from markdown files as autodoc…
cf7ebff 
… does not support this yet
@benne238
added additional information for the overview
f3b9d67
@benne238
update api.py docstrings
fdf4aeb
@campb303
Remove JWT Refresh path restriction
a5a185d
@campb303
Create get_access_token snippet
1fe26c6
@campb303
Merge branch 'update-docs' of github.itap.purdue.edu:ECN/webqueue2-ap…
f631916 
…i into update-docs
campb303 added 29 commits June 21, 2021 14:42
@campb303
Add mkdocs-macros-plugin to dependencies
26e7938
@campb303
Update Dev Environment Setup Guide
ca58cc1
@campb303
Remove stub doc
60168f4
@campb303
Update Item endpoint and params docs
2b026ee
@campb303
Update Queue endpoint and params docs
15a6697
@campb303
Update docstring
158dabd
@campb303
Update item.py
b08d79d
@campb303
Merge pull request #34 from ECN/update-item-repr
8baa833 
Change Item repr to `f"{queue}{number} ({user_alias}) {subject}"`
@campb303
Remove old module files
7d91019
@campb303
Add 500 return code to docstring
981a973
@campb303
Add 500 return code to docstring
5607d12
@campb303
Add 500 error code to docstring
56d4ba8
@campb303
Add 500 error code to docstring
e9f0a14
@campb303
Add docstring to RefreshAccessToken resource
9af4296
@campb303
Add type info to Item attributes
076a5b2
@campb303
Correct Item.json_data type in docstring
ed5f48e
@campb303
Update Item.__get_time_last_updated docstring to reflect ISO 8601 formt
0e8b1dc
@campb303
Add output example to Queue.__generate_json_data docstring
3408d37
@campb303
Remove non-existent arg from is_valid_item_name function
13d1e27
@campb303
Moved docs source files from docs/ to docs-src/ for GitHub pages
04654f8
@campb303
Move MkDocs src and build directories for GitHub pages
9078083
@campb303
Remove unused package structure docs
57abb05
@campb303
Add webqueue2api Package Getting Started docs
f9a8616
@campb303
Add virtual environment and how to run notes
ed870f8
@campb303
Move Installation docs to top level
b005765
@campb303
Update installation link
93f1a13
@campb303
Create webqueue2api Package section and Getting Started docs
aa145e1
@campb303
Add Package Structure docs and configuration usage example
14e9148
@campb303
Add mkautodocs plugins
3917396
@campb303 campb303 merged commit 232fc14 into master Jul 1, 2021
Sign in to join this conversation on GitHub.
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@campb303 @benne238