Transfer from internal development repository

Author: ncoghlan

.gitignore

@@ -0,0 +1,164 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm-project.org/#use-with-ide
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+.DS_Store

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lmsjs-schema/lmstudio.js"]
+	path = lmsjs-schema/lmstudio.js
+	url = https://github.com/lmstudio-ai/lmstudio.js

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Contributing
+
+`lmstudio-python` is the Python SDK for LM Studio. It is an open-source project under the Apache 2.0 license. We welcome community contributions. There are many ways to help, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or contributing code which can be incorporated into the SDK itself.
+
+Note: the SDK documentation is maintained in combination with the [`lmstudio.js`](https://github.com/lmstudio-ai/lmstudio.js)
+in a dedicated [documentation repo](https://github.com/lmstudio-ai/docs).
+
+## Before you start
+
+If you are planning to add a feature or fix a bug, please open an issue first to discuss it. This is mainly to avoid duplicate work and to make sure that your contribution is in line with the project's goals. The LM Studio team is available to chat in the `#dev-chat` channel within the [LM Studio Discord server](https://discord.gg/pwQWNhmQTY).
+
+## How to make code contributions
+
+_`lmstudio-python` requires Python 3.11 or later_
+
+1. Fork this repository
+2. Clone your fork: `git clone [email protected]:lmstudio-ai/lmstudio-python.git` onto your local development machine
+3. Install the `tox` environment manager via your preferred mechanism (such as `pipx` or `uvx`)
+4. Run `tox -m test` to run the test suite (`pytest` is the test runner, pass options after a `--` separator)
+5. Run `tox -m static` to run the linter and typechecker
+6. Run `tox -e format` to run the code autoformatter
+
+Refer to [`README.md`](./README.md) and [`testing/README.md`](testing/README.md)for additional details
+on working with the `lmstudio-python` code and test suite.
+
+## Q&A
+
+- **How does `lmstudio-python` communicate with LM Studio?**
+
+  `lmstudio-python` communicates with LM Studio through its native dedicated websocket API, rather than via its Open AI compatibility layer.
+
+- **How does `lmstudio-python` relate to `lmstudio.js`?**
+
+  `lmstudio-python` communicates with LM Studio based on JSON interface types defined in `lmstudio.js`.
+  The `lmstudio-python` repository includes `lmstudio.js` as a submodule in order to support generating
+  the Python API interface classes from the JSON schema definitions exported by `lmstudio.js`.
+
+## Questions
+
+If you have any other questions, feel free to join the [LM Studio Discord server](https://discord.gg/pwQWNhmQTY) and ask in the `#dev-chat` channel.
+
+## Is the LM Studio team hiring?
+
+Yes, yes we are. Please see our careers page: https://lmstudio.ai/careers.