Skip to content

Commit 09c4163

Browse files
aosinghaosingh
authored
Merge pull request #1 from oracle/ogho/v1.0.0.dev7
v1.0.0.dev7
2 parents 2fcd123 + f9c6f96 commit 09c4163

File tree

81 files changed

+5666
-24
lines changed

Some content is hidden

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

81 files changed

+5666
-24
lines changed

‎.gitignore‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
my_examples
2+
.idea
3+
.venv
4+
.DS_Store
5+
select_ai.egg-info
6+
dist
7+
.ruff_cache
8+
src/select_ai.egg-info
9+
doc/.DS_Store
10+
doc/build
11+
doc/drawio
12+
**/__pycache__
13+
test.env

‎.pre-commit-config.yaml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.4.0
4+
hooks:
5+
- id: trailing-whitespace
6+
- id: end-of-file-fixer
7+
- id: check-yaml
8+
- id: check-added-large-files
9+
args: ['--maxkb=600']
10+
- repo: https://github.com/psf/black-pre-commit-mirror
11+
rev: 24.4.2
12+
hooks:
13+
- id: black
14+
- repo: https://github.com/astral-sh/ruff-pre-commit
15+
rev: v0.0.291
16+
hooks:
17+
- id: ruff
18+
args: ["check", "--select", "I", "--fix"]

‎CONTRIBUTING.md‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
*Detailed instructions on how to contribute to the project, if applicable. Must include section about Oracle Contributor Agreement with link and instructions*
2-
31
# Contributing to this repository
42

53
We welcome your contributions! There are multiple ways to contribute.
@@ -48,6 +46,28 @@ can be accepted.
4846
your changes. Ensure that you reference the issue you created as well.
4947
1. We will assign the pull request to 2-3 people for review before it is merged.
5048

49+
50+
51+
### Install development dependencies
52+
53+
```bash
54+
python3 -m venv .venv
55+
source .venv/bin/activate
56+
57+
python3 -m pip install --upgrade pip setuptools build pre-commit
58+
59+
python3 -m pip install -e . # installs project in editable mode
60+
61+
pre-commit install # install git hooks
62+
pre-commit run --all-files
63+
```
64+
65+
### Build
66+
67+
```bash
68+
python -m build
69+
```
70+
5171
## Code of conduct
5272

5373
Follow the [Golden Rule](https://en.wikipedia.org/wiki/Golden_Rule). If you'd

‎LICENSE.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Copyright (c) 2023 Oracle and/or its affiliates.
1+
Copyright (c) 2025, Oracle and/or its affiliates.
22

33
The Universal Permissive License (UPL), Version 1.0
44

‎MANIFEST.in‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
recursive-include tests *.py
2+
recursive-include samples *.py

‎README.md‎

Lines changed: 11 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,24 @@
1-
*This repository acts as a template for all of Oracle’s GitHub repositories. It contains information about the guidelines for those repositories. All files and sections contained in this template are mandatory, and a GitHub app ensures alignment with these guidelines. To get started with a new repository, replace the italic paragraphs with the respective text for your project.*
1+
# Select AI for Python
22

3-
# Project name
43

5-
*Describe your project's features, functionality and target audience*
4+
Select AI for Python enables you to ask questions of your database data using natural language (text-to-SQL), get generative AI responses using your trusted content (retrieval augmented generation), generate synthetic data using large language models, and other features – all from Python. With the general availability of Select AI Python, Python developers have access to the functionality of Select AI on Oracle Autonomous Database.
65

7-
## Installation
8-
9-
*Provide detailed step-by-step installation instructions. You can name this section **How to Run** or **Getting Started** instead of **Installation** if that's more acceptable for your project*
10-
11-
## Documentation
6+
Select AI for Python enables you to leverage the broader Python ecosystem in combination with generative AI and database functionality - bridging the gap between the DBMS_CLOUD_AI PL/SQL package and Python's rich ecosystem. It provides intuitive objects and methods for AI model interaction.
127

13-
*Developer-oriented documentation can be published on GitHub, but all product documentation must be published on <https://docs.oracle.com>*
148

15-
## Examples
9+
## Installation
1610

17-
*Describe any included examples or provide a link to a demo/tutorial*
11+
Run
12+
```bash
13+
python3 -m pip install select_ai
14+
```
1815

19-
## Help
16+
## Samples
2017

21-
*Inform users on where to get help or how to receive official support from Oracle (if applicable)*
18+
Examples can be found in the samples directory
2219

2320
## Contributing
2421

25-
*If your project has specific contribution requirements, update the CONTRIBUTING.md file to ensure those requirements are clearly explained*
2622

2723
This project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)
2824

@@ -32,13 +28,7 @@ Please consult the [security guide](./SECURITY.md) for our responsible security
3228

3329
## License
3430

35-
*The correct copyright notice format for both documentation and software is*
36-
"Copyright (c) [year,] year Oracle and/or its affiliates."
37-
*You must include the year the content was first released (on any platform) and the most recent year in which it was revised*
38-
39-
Copyright (c) 2023 Oracle and/or its affiliates.
40-
41-
*Replace this statement if your project is not licensed under the UPL*
31+
Copyright (c) 2025 Oracle and/or its affiliates.
4232

4333
Released under the Universal Permissive License v1.0 as shown at
4434
<https://oss.oracle.com/licenses/upl/>.

‎THIRD_PARTY_LICENSES.txt‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
Third Party Dependencies:
2+
=========================
3+
4+
pandas
5+
======
6+
7+
BSD 3-Clause License
8+
9+
Copyright (c) 2008-2011, AQR Capital Management, LLC, Lambda Foundry, Inc. and PyData Development Team
10+
All rights reserved.
11+
12+
Copyright (c) 2011-2025, Open source contributors.
13+
14+
Redistribution and use in source and binary forms, with or without
15+
modification, are permitted provided that the following conditions are met:
16+
17+
* Redistributions of source code must retain the above copyright notice, this
18+
list of conditions and the following disclaimer.
19+
20+
* Redistributions in binary form must reproduce the above copyright notice,
21+
this list of conditions and the following disclaimer in the documentation
22+
and/or other materials provided with the distribution.
23+
24+
* Neither the name of the copyright holder nor the names of its
25+
contributors may be used to endorse or promote products derived from
26+
this software without specific prior written permission.
27+
28+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
29+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
30+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
31+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
32+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
33+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
34+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎doc/Makefile‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
.PHONY: html
18+
html:
19+
@$(SPHINXBUILD) -M html $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS)
20+
21+
.PHONY: epub
22+
epub:
23+
@$(SPHINXBUILD) -M epub $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS)
24+
25+
.PHONY: pdf
26+
pdf:
27+
@$(SPHINXBUILD) -M latexpdf $(SOURCEDIR) $(BUILDDIR) $(SPHINXOPTS)
28+
29+
.PHONY: clean
30+
clean:
31+
rm -rf $(BUILDDIR)/*

‎doc/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
Sphinx is used to generate documentation
2+
3+
```text
4+
python -m pip install -r requirements.txt
5+
```
6+
7+
For more information on Sphinx, please visit this page:
8+
9+
http://www.sphinx-doc.org
10+
11+
Once Sphinx is installed, the supplied Makefile can be used to build the
12+
different targets, for example to build the HTML documentation, run::
13+
14+
make
15+
16+
To make ePub documentation, run::
17+
18+
make epub
19+
20+
To make PDF documentation, run::
21+
22+
make pdf
23+
24+
The program ``latexmk`` may be required by Sphinx to generate PDF output.

‎doc/requirements.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
sphinx
2+
sphinx-rtd-theme
3+
sphinx_toolbox

0 commit comments

Comments
 (0)