Skip to content

Commit ddf69fa

Browse files
jordancdejordancde
committed
init
1 parent 81d1a4a commit ddf69fa

33 files changed

+1118
-66
lines changed

‎.editorconfig

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# http://editorconfig.org
2+
3+
root = true
4+
5+
[*]
6+
indent_style = space
7+
indent_size = 4
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
charset = utf-8
11+
end_of_line = lf
12+
13+
[*.bat]
14+
indent_style = tab
15+
end_of_line = crlf
16+
17+
[LICENSE]
18+
insert_final_newline = false
19+
20+
[Makefile]
21+
indent_style = tab

‎.github/ISSUE_TEMPLATE.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
* Vapi Python SDK version:
2+
* Python version:
3+
* Operating System:
4+
5+
### Description
6+
7+
Describe what you were trying to get done.
8+
Tell us what happened, what went wrong, and what you expected to happen.
9+
10+
### What I Did
11+
12+
```
13+
Paste the command(s) you ran and the output.
14+
If there was a crash, please include the traceback here.
15+
```

‎.gitignore

+10-64
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ __pycache__/
88

99
# Distribution / packaging
1010
.Python
11+
env/
1112
build/
1213
develop-eggs/
1314
dist/
@@ -20,11 +21,9 @@ parts/
2021
sdist/
2122
var/
2223
wheels/
23-
share/python-wheels/
2424
*.egg-info/
2525
.installed.cfg
2626
*.egg
27-
MANIFEST
2827

2928
# PyInstaller
3029
# Usually these files are written by a python script from a template
@@ -39,17 +38,14 @@ pip-delete-this-directory.txt
3938
# Unit test / coverage reports
4039
htmlcov/
4140
.tox/
42-
.nox/
4341
.coverage
4442
.coverage.*
4543
.cache
4644
nosetests.xml
4745
coverage.xml
4846
*.cover
49-
*.py,cover
5047
.hypothesis/
5148
.pytest_cache/
52-
cover/
5349

5450
# Translations
5551
*.mo
@@ -58,8 +54,6 @@ cover/
5854
# Django stuff:
5955
*.log
6056
local_settings.py
61-
db.sqlite3
62-
db.sqlite3-journal
6357

6458
# Flask stuff:
6559
instance/
@@ -72,61 +66,27 @@ instance/
7266
docs/_build/
7367

7468
# PyBuilder
75-
.pybuilder/
7669
target/
7770

7871
# Jupyter Notebook
7972
.ipynb_checkpoints
8073

81-
# IPython
82-
profile_default/
83-
ipython_config.py
84-
8574
# 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
75+
.python-version
76+
77+
# celery beat schedule file
11678
celerybeat-schedule
117-
celerybeat.pid
11879

11980
# SageMath parsed files
12081
*.sage.py
12182

122-
# Environments
83+
# dotenv
12384
.env
85+
86+
# virtualenv
12487
.venv
125-
env/
12688
venv/
12789
ENV/
128-
env.bak/
129-
venv.bak/
13090

13191
# Spyder project settings
13292
.spyderproject
@@ -140,21 +100,7 @@ venv.bak/
140100

141101
# mypy
142102
.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/
154103

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/
104+
# IDE settings
105+
.vscode/
106+
.idea/

‎.travis.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Config file for automatic testing at travis-ci.com
2+
3+
language: python
4+
python:
5+
- 3.8
6+
- 3.7
7+
- 3.6
8+
9+
# Command to install dependencies, e.g. pip install -r requirements.txt --use-mirrors
10+
install:
11+
- pip install -U tox-travis
12+
- pip install -r requirements.txt
13+
14+
# Command to run tests, e.g. python setup.py test
15+
script: tox
16+
17+
# Assuming you have installed the travis-ci CLI tool, after you
18+
# create the Github repo and add it to Travis, run the
19+
# following command to finish PyPI deployment setup:
20+
# $ travis encrypt --add deploy.password
21+
deploy:
22+
provider: pypi
23+
distributions: sdist bdist_wheel
24+
user: jordan.cde
25+
password:
26+
secure: PLEASE_REPLACE_ME
27+
on:
28+
tags: true
29+
repo: jordan.cde/vapi_python
30+
python: 3.8

‎AUTHORS.rst

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
=======
2+
Credits
3+
=======
4+
5+
Development Lead
6+
----------------
7+
8+
* Vapi AI <[email protected]>
9+
10+
Contributors
11+
------------
12+
13+
None yet. Why not be the first?

‎CONTRIBUTING.rst

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
.. highlight:: shell
2+
3+
============
4+
Contributing
5+
============
6+
7+
Contributions are welcome, and they are greatly appreciated! Every little bit
8+
helps, and credit will always be given.
9+
10+
You can contribute in many ways:
11+
12+
Types of Contributions
13+
----------------------
14+
15+
Report Bugs
16+
~~~~~~~~~~~
17+
18+
Report bugs at https://github.com/jordan.cde/vapi_python/issues.
19+
20+
If you are reporting a bug, please include:
21+
22+
* Your operating system name and version.
23+
* Any details about your local setup that might be helpful in troubleshooting.
24+
* Detailed steps to reproduce the bug.
25+
26+
Fix Bugs
27+
~~~~~~~~
28+
29+
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
30+
wanted" is open to whoever wants to implement it.
31+
32+
Implement Features
33+
~~~~~~~~~~~~~~~~~~
34+
35+
Look through the GitHub issues for features. Anything tagged with "enhancement"
36+
and "help wanted" is open to whoever wants to implement it.
37+
38+
Write Documentation
39+
~~~~~~~~~~~~~~~~~~~
40+
41+
Vapi Python SDK could always use more documentation, whether as part of the
42+
official Vapi Python SDK docs, in docstrings, or even on the web in blog posts,
43+
articles, and such.
44+
45+
Submit Feedback
46+
~~~~~~~~~~~~~~~
47+
48+
The best way to send feedback is to file an issue at https://github.com/jordan.cde/vapi_python/issues.
49+
50+
If you are proposing a feature:
51+
52+
* Explain in detail how it would work.
53+
* Keep the scope as narrow as possible, to make it easier to implement.
54+
* Remember that this is a volunteer-driven project, and that contributions
55+
are welcome :)
56+
57+
Get Started!
58+
------------
59+
60+
Ready to contribute? Here's how to set up `vapi_python` for local development.
61+
62+
1. Fork the `vapi_python` repo on GitHub.
63+
2. Clone your fork locally::
64+
65+
$ git clone [email protected]:your_name_here/vapi_python.git
66+
67+
3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
68+
69+
$ mkvirtualenv vapi_python
70+
$ cd vapi_python/
71+
$ python setup.py develop
72+
73+
4. Create a branch for local development::
74+
75+
$ git checkout -b name-of-your-bugfix-or-feature
76+
77+
Now you can make your changes locally.
78+
79+
5. When you're done making changes, check that your changes pass flake8 and the
80+
tests, including testing other Python versions with tox::
81+
82+
$ flake8 vapi_python tests
83+
$ python setup.py test or pytest
84+
$ tox
85+
86+
To get flake8 and tox, just pip install them into your virtualenv.
87+
88+
6. Commit your changes and push your branch to GitHub::
89+
90+
$ git add .
91+
$ git commit -m "Your detailed description of your changes."
92+
$ git push origin name-of-your-bugfix-or-feature
93+
94+
7. Submit a pull request through the GitHub website.
95+
96+
Pull Request Guidelines
97+
-----------------------
98+
99+
Before you submit a pull request, check that it meets these guidelines:
100+
101+
1. The pull request should include tests.
102+
2. If the pull request adds functionality, the docs should be updated. Put
103+
your new functionality into a function with a docstring, and add the
104+
feature to the list in README.rst.
105+
3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
106+
https://travis-ci.com/jordan.cde/vapi_python/pull_requests
107+
and make sure that the tests pass for all supported Python versions.
108+
109+
Tips
110+
----
111+
112+
To run a subset of tests::
113+
114+
115+
$ python -m unittest tests.test_vapi_python
116+
117+
Deploying
118+
---------
119+
120+
A reminder for the maintainers on how to deploy.
121+
Make sure all your changes are committed (including an entry in HISTORY.rst).
122+
Then run::
123+
124+
$ bump2version patch # possible: major / minor / patch
125+
$ git push
126+
$ git push --tags
127+
128+
Travis will then deploy to PyPI if tests pass.

‎HISTORY.rst

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
=======
2+
History
3+
=======
4+
5+
0.1.0 (2023-11-17)
6+
------------------
7+
8+
* First release on PyPI.

‎LICENSE

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2023 Vapi
3+
Copyright (c) 2023, Vapi AI
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -19,3 +19,4 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22+

‎MANIFEST.in

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
include AUTHORS.rst
2+
include CONTRIBUTING.rst
3+
include HISTORY.rst
4+
include LICENSE
5+
include README.rst
6+
7+
recursive-include tests *
8+
recursive-exclude * __pycache__
9+
recursive-exclude * *.py[co]
10+
11+
recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif

0 commit comments

Comments
 (0)