Skip to content

Commit e1e5db8

Browse files
dhrubo-osdhrubo-os
authoredNov 16, 2022
removing installation guide + adding more md files (opensearch-project#26)
* removing installation guide + adding more md files Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> * added warning Signed-off-by: Dhrubo Saha <dhrubo@amazon.com> Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
1 parent 3392ad5 commit e1e5db8

12 files changed

+132
-12
lines changed
 

‎.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This should match the team set up in https://github.com/orgs/opensearch-project/teams and include any additional contributors
2+
* @dhrubo-os @mingshl

‎.github/workflows/backport.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Backport
2+
on:
3+
pull_request_target:
4+
types:
5+
- closed
6+
- labeled
7+
8+
jobs:
9+
backport:
10+
runs-on: ubuntu-latest
11+
permissions:
12+
contents: write
13+
pull-requests: write
14+
name: Backport
15+
steps:
16+
- name: GitHub App token
17+
id: github_app_token
18+
uses: tibdex/github-app-token@v1.5.0
19+
with:
20+
app_id: ${{ secrets.APP_ID }}
21+
private_key: ${{ secrets.APP_PRIVATE_KEY }}
22+
installation_id: 22958780
23+
24+
- name: Backport
25+
uses: VachaShah/backport@v1.1.4
26+
with:
27+
github_token: ${{ steps.github_app_token.outputs.token }}
28+
branch_name: backport/backport-${{ github.event.number }}

‎.github/workflows/delete_backport_branch.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Delete merged branch of the backport PRs
2+
on:
3+
pull_request:
4+
types:
5+
- closed
6+
7+
jobs:
8+
delete-branch:
9+
runs-on: ubuntu-latest
10+
if: startsWith(github.event.pull_request.head.ref,'backport/')
11+
steps:
12+
- name: Delete merged branch
13+
uses: SvanBoxel/delete-merged-branch@main
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.whitesource

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"scanSettings": {
3+
"configMode": "AUTO",
4+
"configExternalURL": "",
5+
"projectToken": "",
6+
"baseBranches": []
7+
},
8+
"checkRunSettings": {
9+
"vulnerableCheckRunConclusionLevel": "failure",
10+
"displayMode": "diff"
11+
},
12+
"issueSettings": {
13+
"minSeverityLevel": "LOW"
14+
}
15+
}

‎ADMINS.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
- [Current Admins](#current-admins)
2+
- [Admin Responsibilities](#admin-responsibilities)
3+
4+
## Current Admins
5+
6+
| Admin | GitHub ID | Affiliation |
7+
| ---------------- | --------------------------------------- | ----------- |
8+
| Charlotte Henkle | [CEHENKLE](https://github.com/CEHENKLE) | Amazon |
9+
| Henri Yandell | [hyandell](https://github.com/hyandell) | Amazon |
10+
11+
12+
## Admin Responsibilities
13+
14+
[This document](https://github.com/opensearch-project/.github/blob/main/ADMINS.md#admin-responsibilities) explains what admins do in this repo, and how they should be doing it.

‎COMPATIBILITY.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
- [Compatibility with OpenSearch](#compatibility-with-opensearch)
2+
3+
## Compatibility with OpenSearch
4+
5+
The below matrix shows the compatibility of the [`opensearch-py-ml`](https://pypi.org/project/opensearch-py-ml/) with versions of [`OpenSearch`](https://opensearch.org/downloads.html#opensearch).
6+
7+
| OpenSearch Version | Client Version |
8+
|--------------------| --- |
9+
| 2.4.0 | 1.0.0 |
10+
11+

‎RELEASING.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
- [Overview](#overview)
2+
- [Branching](#branching)
3+
- [Release Branching](#release-branching)
4+
- [Feature Branches](#feature-branches)
5+
- [Release Labels](#release-labels)
6+
- [Releasing](#releasing)
7+
8+
## Overview
9+
10+
This document explains the release strategy for artifacts in this organization.
11+
12+
## Branching
13+
14+
### Release Branching
15+
16+
Given the current major release of 1.0, projects in this organization maintain the following active branches.
17+
18+
* **main**: The next _major_ release. This is the branch where all merges take place and code moves fast.
19+
20+
21+
Label PRs with the next major version label (e.g. `2.0.0`) and merge changes into `main`. Label PRs that you believe need to be backported as `1.x` and `1.0`. Backport PRs by checking out the versioned branch, cherry-pick changes and open a PR against each target backport branch.
22+
23+
### Feature Branches
24+
25+
Do not creating branches in the upstream repo, use your fork, for the exception of long lasting feature branches that require active collaboration from multiple developers. Name feature branches `feature/<thing>`. Once the work is merged to `main`, please make sure to delete the feature branch.
26+
27+
## Release Labels
28+
29+
Repositories create consistent release labels, such as `v1.0.0`, `v1.1.0` and `v2.0.0`, as well as `patch` and `backport`. Use release labels to target an issue or a PR for a given release. See [MAINTAINERS](MAINTAINERS.md#triage-open-issues) for more information on triaging issues.
30+
31+
## Releasing
32+
33+
The release process is standard across repositories in this org and is run by a release manager volunteering from amongst [MAINTAINERS](MAINTAINERS.md).

‎SECURITY.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Reporting a Vulnerability
2+
3+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/) or directly via email to aws-security@amazon.com. Please do **not** create a public GitHub issue.

‎docs/source/index.rst

+3-7
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,11 @@ Where possible the package uses existing Python APIs and data structures to make
1919
pandas, scikit-learn to their Opensearch powered equivalents. In general, the data resides in Opensearch and
2020
not in memory, which allows Opensearch-py-ml to access large datasets stored in Opensearch.
2121

22-
Installing Opensearch-py-ml
23-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
2422

25-
Opensearch-py-ml can be installed from `PyPI <https://pypi.org/project/opensearch-py-ml>`_ via pip:
26-
27-
.. code-block:: bash
28-
29-
$ python -m pip install opensearch-py-ml
23+
WARNING
24+
~~~~~~~~~~~~~~~
3025

26+
Current `opensearch-py-ml` in pypi is not related to this package. We are working to get it updated but please **don't** use it until further notice.
3127

3228
Getting Started
3329
~~~~~~~~~~~~~~~

‎opensearch_py_ml/_version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@
2727
__title__ = "opensearch_py_ml"
2828
__description__ = "Python Client and Toolkit for DataFrames, Big Data, Machine Learning and ETL in OpenSearch"
2929
__url__ = "https://github.com/opensearch-project/opensearch-py-ml"
30-
__version__ = "2.2.0"
30+
__version__ = "1.0.0"
3131
__author__ = "Dhrubo Saha"
32-
__author_email__ = "dhrubo@amazon.com"
32+
__author_email__ = "dhrubo@amazon.com, "
3333
__maintainer__ = "Dhrubo Saha, Yaliang Wu"
3434
__maintainer_email__ = "dhrubo@amazon.com, ylwu@amazon.com"

‎setup.py

+4-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@
4242
"Operating System :: OS Independent",
4343
"Intended Audience :: Developers",
4444
"Intended Audience :: Science/Research",
45-
"Operating System :: OS Independent",
4645
"Programming Language :: Python",
4746
"Programming Language :: Python :: 3",
4847
"Programming Language :: Python :: 3 :: Only",
@@ -79,6 +78,10 @@
7978
classifiers=CLASSIFIERS,
8079
keywords="Opensearch opensearch_py_ml pandas python",
8180
packages=find_packages(include=["opensearch_py_ml", "opensearch_py_ml.*"]),
81+
project_urls={
82+
"Source Code": "https://github.com/opensearch-project/opensearch-py-ml",
83+
"Issue Tracker": "https://github.com/opensearch-project/opensearch-py-ml/issues",
84+
},
8285
install_requires=[
8386
"opensearch-py>=2",
8487
"pandas>=1.5,<2",

‎tests/series/test_arithmetics_pytest.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ def test_ecommerce_datetime_comparisons(self):
6262
# convert to timezone naive datetime object
6363
pd_df["order_date"] = pd_df["order_date"].dt.tz_localize(None)
6464

65-
class ModifiedElandSeries(Series):
65+
class ModifiedOMLSeries(Series):
6666
def to_pandas(self):
6767
"""remove timezone awareness before returning the pandas dataframe"""
6868
series = super().to_pandas()
@@ -78,7 +78,7 @@ def to_pandas(self):
7878
]
7979

8080
# "type cast" to modified class (inherits from ed.Series) that overrides the `to_pandas` function
81-
oml_series.__class__ = ModifiedElandSeries
81+
oml_series.__class__ = ModifiedOMLSeries
8282

8383
assert_pandas_opensearch_py_ml_series_equal(
8484
pd_series, oml_series, check_less_precise=True

0 commit comments

Comments
 (0)
Please sign in to comment.