Skip to content

Commit 33b615d

Browse files
committed
re-gen w/ new package name for docs and fix build command
1 parent 8ee77a1 commit 33b615d

File tree

430 files changed

+1681
-1817
lines changed

Some content is hidden

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

430 files changed

+1681
-1817
lines changed

client/.github/workflows/python.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# ref: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
55

6-
name: generated Python package
6+
name: client Python package
77

88
on: [push, pull_request]
99

client/.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ stages:
1212
script:
1313
- pip install -r requirements.txt
1414
- pip install -r test-requirements.txt
15-
- pytest --cov=generated
15+
- pytest --cov=client
1616

1717
pytest-3.8:
1818
extends: .pytest

client/.openapi-generator-ignore

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,3 @@
2121
#docs/*.md
2222
# Then explicitly reverse the ignore rule for a single file:
2323
#!docs/README.md
24-
25-
# Don't regenerate README - we have a custom one
26-
README.md

client/.openapi-generator/FILES

Lines changed: 231 additions & 231 deletions
Large diffs are not rendered by default.

client/.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ install:
1414
- "pip install -r requirements.txt"
1515
- "pip install -r test-requirements.txt"
1616
# command to run tests
17-
script: pytest --cov=generated
17+
script: pytest --cov=client

client/README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,44 @@
1-
# FastComments API Client
1+
# fastcomments-python
2+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
23

3-
The FastComments API client for Python. This package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project.
4+
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
45

5-
- API version: 0.0.1
6+
- API version: 0.0.0
67
- Package version: 0.0.1
78
- Generator version: 7.11.0
89
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
910

10-
**Note:** This is a submodule of the `fastcomments-python` package. For general usage, please refer to the [main package README](../README.md).
11-
1211
## Requirements.
1312

1413
Python 3.8+
1514

1615
## Installation & Usage
1716
### pip install
1817

19-
Install the main package:
18+
If the python package is hosted on a repository, you can install directly using:
2019

2120
```sh
22-
pip install fastcomments-python
21+
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
2322
```
23+
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
2424

25-
Then import the client module:
25+
Then import the package:
2626
```python
27-
from client import ApiClient, Configuration, DefaultApi, PublicApi
27+
import client
2828
```
2929

3030
### Setuptools
3131

32-
Or install from source:
32+
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
3333

3434
```sh
35-
pip install -e .
35+
python setup.py install --user
3636
```
37+
(or `sudo python setup.py install` to install the package for all users)
3738

38-
Then import the client module:
39+
Then import the package:
3940
```python
40-
from client import ApiClient, Configuration, DefaultApi, PublicApi
41+
import client
4142
```
4243

4344
### Tests
@@ -50,21 +51,25 @@ Please follow the [installation procedure](#installation--usage) and then run th
5051

5152
```python
5253

53-
from client import ApiClient, Configuration, PublicApi
54-
from client.exceptions import ApiException
54+
import client
55+
from client.rest import ApiException
5556
from pprint import pprint
5657

57-
# Configure the host (defaults to FastComments production API)
58-
configuration = Configuration(
59-
host = "https://fastcomments.com/api"
58+
# Defining the host is optional and defaults to https://fastcomments.com
59+
# See configuration.py for a list of all supported configuration parameters.
60+
configuration = client.Configuration(
61+
host = "https://fastcomments.com"
6062
)
6163

64+
65+
6266
# Enter a context with an instance of the API client
63-
with ApiClient(configuration) as api_client:
67+
with client.ApiClient(configuration) as api_client:
6468
# Create an instance of the API class
65-
api_instance = PublicApi(api_client)
66-
tenant_id = 'YOUR_TENANT_ID' # str | Your FastComments tenant ID
67-
url_id = 'my-page' # str | The URL identifier for the page
69+
api_instance = client.PublicApi(api_client)
70+
tenant_id = 'tenant_id_example' # str |
71+
comment_id = 'comment_id_example' # str |
72+
public_block_from_comment_params = client.PublicBlockFromCommentParams() # PublicBlockFromCommentParams |
6873
sso = 'sso_example' # str | (optional)
6974

7075
try:

client/docs/APICreateUserBadgeResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Name | Type | Description | Notes
1111
## Example
1212

1313
```python
14-
from generated.models.api_create_user_badge_response import APICreateUserBadgeResponse
14+
from client.models.api_create_user_badge_response import APICreateUserBadgeResponse
1515

1616
# TODO update the JSON string below
1717
json = "{}"

client/docs/APIEmptyResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
## Example
1111

1212
```python
13-
from generated.models.api_empty_response import APIEmptyResponse
13+
from client.models.api_empty_response import APIEmptyResponse
1414

1515
# TODO update the JSON string below
1616
json = "{}"

client/docs/APIEmptySuccessResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
1010
## Example
1111

1212
```python
13-
from generated.models.api_empty_success_response import APIEmptySuccessResponse
13+
from client.models.api_empty_success_response import APIEmptySuccessResponse
1414

1515
# TODO update the JSON string below
1616
json = "{}"

client/docs/APIError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
1717
## Example
1818

1919
```python
20-
from generated.models.api_error import APIError
20+
from client.models.api_error import APIError
2121

2222
# TODO update the JSON string below
2323
json = "{}"

0 commit comments

Comments
 (0)