Skip to content

Commit 6b61a06

Browse files
authored
Merge pull request #55 from MarketSquare/v1_release
V1 release: major (internal) refactor and interface / terminology corrections
2 parents fee9009 + a1aef54 commit 6b61a06

File tree

166 files changed

+12118
-16702
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

166 files changed

+12118
-16702
lines changed

.devcontainer/Dockerfile

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM python:3.13-slim-bookworm
1+
FROM python:3.10-slim-bookworm
22

33
# Update the certificates
44
RUN apt-get update && \
@@ -32,10 +32,9 @@ ENV PATH="$PATH:$POETRY_HOME/bin"
3232
RUN curl -sSL https://install.python-poetry.org | python3 -
3333
RUN poetry self update
3434

35-
# Configure poetry to not create virtual environments.
36-
# This is done to force package installation to the global Python install so that users
37-
# other than the Docker root user have access to the installed packages.
38-
RUN poetry config virtualenvs.create false
35+
# Configure poetry to create virtual environments in the project.
36+
# This is done to be compatible with how uv and PDM set up the venvs.
37+
RUN poetry config virtualenvs.in-project true
3938

4039
EXPOSE 8888
4140
ENTRYPOINT ["/bin/sh"]

.devcontainer/devcontainer.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@
1414
// Configure tool-specific properties.
1515
"customizations": {
1616
"vscode": {
17-
// Set *default* container specific settings.json values on container create.
18-
"settings": {
19-
"robotcode.robot.variables": {
20-
"ROOT": "/workspaces/robotframework-openapitools"
21-
}
22-
},
2317
"extensions": [
2418
"ms-python.python",
2519
"ms-python.vscode-pylance",

.gitignore

Lines changed: 11 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -1,139 +1,36 @@
1-
# Byte-compiled / optimized / DLL files
2-
__pycache__/
3-
*.py[cod]
4-
*$py.class
5-
6-
# C extensions
7-
*.so
1+
# caches
2+
__pycache__
3+
.mypy_cache/
4+
.ruff_cache
5+
.robotcode_cache
6+
.pytest_cache/
87

98
# Distribution / packaging
10-
.Python
119
build/
12-
develop-eggs/
1310
dist/
14-
downloads/
15-
eggs/
16-
.eggs/
17-
lib/
18-
lib64/
19-
parts/
2011
sdist/
21-
var/
2212
wheels/
23-
pip-wheel-metadata/
24-
share/python-wheels/
2513
*.egg-info/
26-
.installed.cfg
27-
*.egg
28-
MANIFEST
2914

30-
# PyInstaller
31-
# Usually these files are written by a python script from a template
32-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
33-
*.manifest
34-
*.spec
35-
36-
# Installer logs
37-
pip-log.txt
38-
pip-delete-this-directory.txt
39-
40-
# Unit test / coverage reports
15+
# coverage reports
4116
htmlcov/
42-
.tox/
43-
.nox/
4417
.coverage
4518
.coverage.*
46-
.cache
47-
nosetests.xml
4819
coverage.xml
4920
*.cover
50-
*.py,cover
51-
.hypothesis/
52-
.pytest_cache/
53-
54-
# Translations
55-
*.mo
56-
*.pot
57-
58-
# Django stuff:
59-
*.log
60-
local_settings.py
61-
db.sqlite3
62-
db.sqlite3-journal
63-
64-
# Flask stuff:
65-
instance/
66-
.webassets-cache
67-
68-
# Scrapy stuff:
69-
.scrapy
70-
71-
# Sphinx documentation
72-
docs/_build/
73-
74-
# PyBuilder
75-
target/
76-
77-
# Jupyter Notebook
78-
.ipynb_checkpoints
79-
80-
# IPython
81-
profile_default/
82-
ipython_config.py
83-
84-
# pyenv
85-
.python-version
86-
87-
# pipenv
88-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
89-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
90-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
91-
# install all needed dependencies.
92-
#Pipfile.lock
93-
94-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
95-
__pypackages__/
96-
97-
# Celery stuff
98-
celerybeat-schedule
99-
celerybeat.pid
100-
101-
# SageMath parsed files
102-
*.sage.py
10321

10422
# Environments
10523
.env
10624
.venv
10725
env/
10826
venv/
109-
ENV/
110-
env.bak/
111-
venv.bak/
112-
113-
# Spyder project settings
114-
.spyderproject
115-
.spyproject
116-
117-
# Rope project settings
118-
.ropeproject
119-
120-
# mkdocs documentation
121-
/site
122-
123-
# mypy
124-
.mypy_cache/
125-
.dmypy.json
126-
dmypy.json
127-
128-
# ruff
129-
.ruff_cache
130-
131-
# Pyre type checker
132-
.pyre/
13327

13428
# IDE config
13529
.vscode/launch.json
13630
.vscode/settings.json
13731

138-
# default logs location for project
32+
# default logs location for the repo
13933
tests/logs
34+
35+
# generated test library
36+
tests/generated

.vscode/example.launch.json

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
// Use IntelliSense to learn about possible attributes.
3+
// Hover to view descriptions of existing attributes.
4+
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5+
"version": "0.2.0",
6+
"configurations": [
7+
{
8+
"name": "Python Debugger: testserver",
9+
"type": "debugpy",
10+
"request": "launch",
11+
"module": "uvicorn",
12+
"args": [
13+
"testserver:app",
14+
"--app-dir=./tests/server",
15+
"--host=0.0.0.0",
16+
"--port=8000",
17+
]
18+
}
19+
]
20+
}

.vscode/example.settings.json

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
11
{
22
"debugpy.debugJustMyCode": false,
3-
"robotcode.debug.attachPython": true
3+
"robotcode.debug.attachPython": true,
4+
"python.testing.unittestEnabled": true,
5+
"python.testing.unittestArgs": [
6+
"-v",
7+
"-s",
8+
"./tests",
9+
"-p",
10+
"test_*.py"
11+
],
12+
"ruff.organizeImports": true,
13+
"ruff.fixAll": true,
14+
"editor.formatOnSave": true,
15+
"[python]": {
16+
"editor.defaultFormatter": "charliermarsh.ruff",
17+
"editor.formatOnSave": true,
18+
"editor.codeActionsOnSave": {
19+
"source.fixAll": "explicit"
20+
}
21+
},
22+
"[json]": {
23+
"editor.defaultFormatter": "vscode.json-language-features"
24+
}
425
}

docs/README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
1+
[![build](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml/badge.svg)](https://github.com/MarketSquare/robotframework-openapitools/actions/workflows/on-push.yml)
2+
![coverage](coverage-badge.svg)
3+
4+
![latest release](https://img.shields.io/pypi/v/robotframework-openapitools?label=latest%20release)
5+
![Python versions](https://img.shields.io/pypi/pyversions/robotframework-openapitools)
6+
![PyPi downloads](https://img.shields.io/pypi/dm/robotframework-openapitools)
7+
![license](https://img.shields.io/pypi/l/robotframework-openapitools)
8+
19
# OpenApiTools for Robot Framework
210

3-
OpenApiTools is a set of libraries centered around the OpenAPI Specification:
11+
If you're testing an API for which an OpenAPI specification is available (if you have a Swagger UI available, you are), OpenApiTools is for you!
12+
13+
To read everything about it, see the [html documentation](https://marketsquare.github.io/robotframework-openapitools).
414

5-
- [OpenApiDriver](./driver.md)
6-
- [OpenApiLibCore](./libcore.md)
15+
The latest release notes can be found [here](./release_notes/1.0.0.md).

docs/_config.yml

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)