-
Notifications
You must be signed in to change notification settings - Fork 199
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
134 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# Contributor License Agreement | ||
|
||
The following terms are used throughout this agreement: | ||
|
||
You - the person or legal entity including its affiliates asked to accept this agreement. An affiliate is any entity that controls or is controlled by the legal entity, or is under common control with it. | ||
|
||
Project - is an umbrella term that refers to any and all Chesterfield Laboratories Inc. open source projects. | ||
|
||
Contribution - any type of work that is submitted to a Project, including any modifications or additions to existing work. | ||
|
||
Submitted - conveyed to a Project via a pull request, commit, issue, or any form of electronic, written, or verbal communication with Chesterfield Laboratories Inc., contributors or maintainers. | ||
|
||
## 1. Grant of Copyright License. | ||
|
||
Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Chesterfield Laboratories Inc. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your contributions and such derivative works. Except for this license, You reserve all rights, title, and interest in your contributions. | ||
|
||
## 2. Grant of Patent License. | ||
|
||
Subject to the terms and conditions of this agreement, You grant to the Projects’ maintainers, contributors, users and to Chesterfield Laboratories Inc. a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer your contributions, where such license applies only to those patent claims licensable by you that are necessarily infringed by your contribution or by combination of your contribution with the project to which this contribution was submitted. | ||
|
||
If any entity institutes patent litigation - including cross-claim or counterclaim in a lawsuit - against You alleging that your contribution or any project it was submitted to constitutes or is responsible for direct or contributory patent infringement, then any patent licenses granted to that entity under this agreement shall terminate as of the date such litigation is filed. | ||
|
||
## 3. Source of Contribution. | ||
|
||
Your contribution is either your original creation, based upon previous work that, to the best of your knowledge, is covered under an appropriate open source license and you have the right under that license to submit that work with modifications, whether created in whole or in part by you, or you have clearly identified the source of the contribution and any license or other restriction (like related patents, trademarks, and license agreements) of which you are personally aware. | ||
|
||
## References | ||
|
||
Adapted from the Github CLA, under the CC-BY-SA 4.0 license. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# Contributing to Kiln | ||
|
||
## Issues and Bug Tracking | ||
|
||
We use [GitHub issues](https://github.com/Kiln-AI/Kiln/issues) for tracking issues, bugs, and feature requests. | ||
|
||
## Contributing | ||
|
||
Contributors must agree to the [contributor license agreement](CLA.md). | ||
|
||
## Development Environment Setup | ||
|
||
We use [uv](https://github.com/astral-sh/uv) to manage the Python environment and dependencies, and npm to manage the web UI. | ||
|
||
``` | ||
# First install uv: https://github.com/astral-sh/uv | ||
uv sync | ||
cd app/web_ui | ||
# install Node if you don't have it already | ||
npm install | ||
``` | ||
|
||
### Running Development Servers | ||
|
||
Running the web-UI and Python servers separately is useful for development, as both can hot-reload. | ||
|
||
To run the API server, Studio server, and Studio Web UI with auto-reload for development: | ||
|
||
1. In your first terminal: | ||
|
||
```bash | ||
uv run python -m app.desktop.dev_server | ||
``` | ||
|
||
2. In a second terminal, navigate to the web UI directory and start the dev server: | ||
|
||
```bash | ||
cd app/web_ui | ||
npm run dev -- | ||
``` | ||
|
||
3. Open the app: http://localhost:5173/run | ||
|
||
### Running the Desktop App | ||
|
||
Running the desktop app without building an executable: | ||
|
||
- First, build the web UI from the `app/web_ui` directory: `npm run build` | ||
- Then run the desktop app: `uv run python -m app.desktop.desktop` | ||
|
||
### Building the Desktop App | ||
|
||
Typically building desktop apps are done in a CI/CD pipeline, but if you need to build the desktop app locally, you can do so with: | ||
|
||
```bash | ||
cd app/desktop | ||
uv run ./build_desktop_app.sh | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,8 @@ | ||
|
||
Copyright 2024 - Chesterfield Laboratories Inc. | ||
|
||
All rights reserved. | ||
|
||
Copyright (c) Steve Cosman, Chesterfield Laboratories Inc. | ||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,13 @@ | ||
|
||
All rights reserved. | ||
|
||
Copyright (c) Steve Cosman, Chesterfield Laboratories Inc. | ||
This license applies only to the software in the libs/core directory. | ||
|
||
======================================================= | ||
|
||
Copyright 2024 - Chesterfield Laboratories Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -8,6 +8,7 @@ authors = [ | |
{name = "Steve Cosman, Chesterfield Laboratories Inc", email = "[email protected]"} | ||
] | ||
classifiers = [ | ||
"License :: OSI Approved :: MIT License", | ||
"Intended Audience :: Developers", | ||
"Programming Language :: Python :: 3.10", | ||
"Programming Language :: Python :: 3.11", | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,12 @@ | ||
|
||
All rights reserved. | ||
This license applies only to the software in the libs/server directory. | ||
|
||
Copyright (c) Steve Cosman, Chesterfield Laboratories Inc. | ||
======================================================= | ||
|
||
Copyright 2024 - Chesterfield Laboratories Inc. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters