Skip to content

Commit 3fd43ff

Browse files
fern-api[bot]fern-api[bot]
committed
Release 0.0.13
1 parent fc67423 commit 3fd43ff

34 files changed

+2309
-159
lines changed

‎.fernignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Specify files that shouldn't be modified by Fern

‎.github/workflows/ci.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: ci
2+
3+
on: [push]
4+
jobs:
5+
compile:
6+
runs-on: ubuntu-20.04
7+
steps:
8+
- name: Checkout repo
9+
uses: actions/checkout@v3
10+
- name: Set up python
11+
uses: actions/setup-python@v4
12+
with:
13+
python-version: 3.8
14+
- name: Bootstrap poetry
15+
run: |
16+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
17+
- name: Install dependencies
18+
run: poetry install
19+
- name: Compile
20+
run: poetry run mypy .
21+
test:
22+
runs-on: ubuntu-20.04
23+
steps:
24+
- name: Checkout repo
25+
uses: actions/checkout@v3
26+
- name: Set up python
27+
uses: actions/setup-python@v4
28+
with:
29+
python-version: 3.8
30+
- name: Bootstrap poetry
31+
run: |
32+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
33+
- name: Install dependencies
34+
run: poetry install
35+
- name: Test
36+
run: poetry run pytest ./tests/custom/
37+
38+
publish:
39+
needs: [compile, test]
40+
if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
41+
runs-on: ubuntu-20.04
42+
steps:
43+
- name: Checkout repo
44+
uses: actions/checkout@v3
45+
- name: Set up python
46+
uses: actions/setup-python@v4
47+
with:
48+
python-version: 3.8
49+
- name: Bootstrap poetry
50+
run: |
51+
curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1
52+
- name: Install dependencies
53+
run: poetry install
54+
- name: Publish to pypi
55+
run: |
56+
poetry config repositories.remote https://upload.pypi.org/legacy/
57+
poetry --no-interaction -v publish --build --repository remote --username "$PYPI_USERNAME" --password "$PYPI_PASSWORD"
58+
env:
59+
PYPI_USERNAME: ${{ secrets.PYPI_USERNAME }}
60+
PYPI_PASSWORD: ${{ secrets.PYPI_PASSWORD }}

‎.gitignore‎

Lines changed: 2 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -1,160 +1,4 @@
1-
# Byte-compiled / optimized / DLL files
2-
__pycache__/
3-
*.py[cod]
4-
*$py.class
5-
6-
# C extensions
7-
*.so
8-
9-
# Distribution / packaging
10-
.Python
11-
build/
12-
develop-eggs/
131
dist/
14-
downloads/
15-
eggs/
16-
.eggs/
17-
lib/
18-
lib64/
19-
parts/
20-
sdist/
21-
var/
22-
wheels/
23-
share/python-wheels/
24-
*.egg-info/
25-
.installed.cfg
26-
*.egg
27-
MANIFEST
28-
29-
# PyInstaller
30-
# Usually these files are written by a python script from a template
31-
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32-
*.manifest
33-
*.spec
34-
35-
# Installer logs
36-
pip-log.txt
37-
pip-delete-this-directory.txt
38-
39-
# Unit test / coverage reports
40-
htmlcov/
41-
.tox/
42-
.nox/
43-
.coverage
44-
.coverage.*
45-
.cache
46-
nosetests.xml
47-
coverage.xml
48-
*.cover
49-
*.py,cover
50-
.hypothesis/
51-
.pytest_cache/
52-
cover/
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-
.pybuilder/
76-
target/
77-
78-
# Jupyter Notebook
79-
.ipynb_checkpoints
80-
81-
# IPython
82-
profile_default/
83-
ipython_config.py
84-
85-
# pyenv
86-
# For a library or package, you might want to ignore these files since the code is
87-
# intended to run in multiple environments; otherwise, check them in:
88-
# .python-version
89-
90-
# pipenv
91-
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92-
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93-
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94-
# install all needed dependencies.
95-
#Pipfile.lock
96-
97-
# poetry
98-
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99-
# This is especially recommended for binary packages to ensure reproducibility, and is more
100-
# commonly ignored for libraries.
101-
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102-
#poetry.lock
103-
104-
# pdm
105-
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106-
#pdm.lock
107-
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108-
# in version control.
109-
# https://pdm.fming.dev/#use-with-ide
110-
.pdm.toml
111-
112-
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113-
__pypackages__/
114-
115-
# Celery stuff
116-
celerybeat-schedule
117-
celerybeat.pid
118-
119-
# SageMath parsed files
120-
*.sage.py
121-
122-
# Environments
123-
.env
124-
.venv
125-
env/
126-
venv/
127-
ENV/
128-
env.bak/
129-
venv.bak/
130-
131-
# Spyder project settings
132-
.spyderproject
133-
.spyproject
134-
135-
# Rope project settings
136-
.ropeproject
137-
138-
# mkdocs documentation
139-
/site
140-
141-
# mypy
1422
.mypy_cache/
143-
.dmypy.json
144-
dmypy.json
145-
146-
# Pyre type checker
147-
.pyre/
148-
149-
# pytype static type analyzer
150-
.pytype/
151-
152-
# Cython debug symbols
153-
cython_debug/
154-
155-
# PyCharm
156-
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
157-
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
158-
# and can be added to the global gitignore or merged into this file. For a more nuclear
159-
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160-
#.idea/
3+
__pycache__/
4+
poetry.toml

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Fileforge.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 64 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,64 @@
1-
# fileforge-python-sdk
1+
<!-- Begin Title, generated by Fern -->
2+
# Fileforge Python Library
3+
4+
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
5+
6+
The Fileforge Python Library provides convenient access to the Fileforge API from applications written in Python.
7+
<!-- End Title -->
8+
9+
<!-- Begin Installation, generated by Fern -->
10+
# Installation
11+
12+
```sh
13+
pip install --upgrade fileforge
14+
```
15+
<!-- End Installation -->
16+
17+
<!-- Begin Usage, generated by Fern -->
18+
# Usage
19+
20+
```python
21+
from fileforge.client import Fileforge
22+
23+
client = Fileforge(
24+
api_key="YOUR_API_KEY",
25+
username="YOUR_USERNAME",
26+
password="YOUR_PASSWORD",
27+
)
28+
```
29+
<!-- End Usage -->
30+
31+
<!-- Begin Async Usage, generated by Fern -->
32+
# Async Client
33+
34+
```python
35+
from fileforge.client import AsyncFileforge
36+
37+
client = AsyncFileforge(
38+
api_key="YOUR_API_KEY",
39+
username="YOUR_USERNAME",
40+
password="YOUR_PASSWORD",
41+
)
42+
```
43+
<!-- End Async Usage -->
44+
45+
<!-- Begin Status, generated by Fern -->
46+
# Beta Status
47+
48+
This SDK is in beta, and there may be breaking changes between versions without a major
49+
version update. Therefore, we recommend pinning the package version to a specific version.
50+
This way, you can install the same version each time without breaking changes.
51+
<!-- End Status -->
52+
53+
<!-- Begin Contributing, generated by Fern -->
54+
# Contributing
55+
56+
While we value open-source contributions to this SDK, this library is generated programmatically.
57+
Additions made directly to this library would have to be moved over to our generation code,
58+
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
59+
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
60+
an issue first to discuss with us!
61+
62+
On the other hand, contributions to the README are always very welcome!
63+
<!-- End Contributing -->
64+

0 commit comments

Comments
 (0)