Update docs / text

nephila · Mar 15, 2024 · 5c9a669 · 5c9a669
1 parent cc9c189
commit 5c9a669
Show file tree

Hide file tree

Showing 8 changed files with 32 additions and 32 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -13,7 +13,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/sabricot/django-elasticsearch-dsl/issues.
+Report bugs at https://github.com/sabricot/django-opensearch-dsl/issues.
 
 If you are reporting a bug, please include:
 
@@ -43,7 +43,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/sabricot/django-elasticsearch-dsl/issues.
+The best way to send feedback is to file an issue at https://github.com/sabricot/django-opensearch-dsl/issues.
 
 If you are proposing a feature:
 
@@ -55,17 +55,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `django-elasticsearch-dsl` for local development.
+Ready to contribute? Here's how to set up `django-opensearch-dsl` for local development.
 
-1. Fork the `django-elasticsearch-dsl` repo on GitHub.
+1. Fork the `django-opensearch-dsl` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/django-elasticsearch-dsl.git
+    $ git clone [email protected]:your_name_here/django-opensearch-dsl.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv django-elasticsearch-dsl
-    $ cd django-elasticsearch-dsl/
+    $ mkvirtualenv django-opensearch-dsl
+    $ cd django-opensearch-dsl/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -101,6 +101,6 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 2.7, and 3.4, and for PyPy. Check
-   https://github.com/django-es/django-elasticsearch-dsl/actions
+   https://github.com/django-es/django-opensearch-dsl/actions
    and make sure that the tests pass for all supported Python versions.
 
diff --git a/README.rst b/README.rst
@@ -2,20 +2,20 @@
 Django Elasticsearch DSL
 ========================
 
-.. image:: https://github.com/django-es/django-elasticsearch-dsl/actions/workflows/ci.yml/badge.svg
-    :target: https://github.com/django-es/django-elasticsearch-dsl/actions/workflows/ci.yml
-.. image:: https://codecov.io/gh/django-es/django-elasticsearch-dsl/coverage.svg?branch=master
-    :target: https://codecov.io/gh/django-es/django-elasticsearch-dsl
-.. image:: https://badge.fury.io/py/django-elasticsearch-dsl.svg
-    :target: https://pypi.python.org/pypi/django-elasticsearch-dsl
-.. image:: https://readthedocs.org/projects/django-elasticsearch-dsl/badge/?version=latest&style=flat
-    :target: https://django-elasticsearch-dsl.readthedocs.io/en/latest/
+.. image:: https://github.com/django-es/django-opensearch-dsl/actions/workflows/ci.yml/badge.svg
+    :target: https://github.com/django-es/django-opensearch-dsl/actions/workflows/ci.yml
+.. image:: https://codecov.io/gh/django-es/django-opensearch-dsl/coverage.svg?branch=master
+    :target: https://codecov.io/gh/django-es/django-opensearch-dsl
+.. image:: https://badge.fury.io/py/django-opensearch-dsl.svg
+    :target: https://pypi.python.org/pypi/django-opensearch-dsl
+.. image:: https://readthedocs.org/projects/django-opensearch-dsl/badge/?version=latest&style=flat
+    :target: https://django-opensearch-dsl.readthedocs.io/en/latest/
 
 Django Elasticsearch DSL is a package that allows indexing of django models in elasticsearch.
 It is built as a thin wrapper around elasticsearch-dsl-py_
 so you can use all the features developed by the elasticsearch-dsl-py team.
 
-You can view the full documentation at https://django-elasticsearch-dsl.readthedocs.io
+You can view the full documentation at https://django-opensearch-dsl.readthedocs.io
 
 .. _elasticsearch-dsl-py: https://github.com/elastic/elasticsearch-dsl-py
 

diff --git a/django_opensearch_dsl/__init__.py b/django_opensearch_dsl/__init__.py
@@ -6,7 +6,7 @@
 from .indices import Index  # noqa
 from .fields import *  # noqa
 
-__version__ = '7.1.1'
+__version__ = '2.0.0'
 
 
 def autodiscover():

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -49,7 +49,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'django-elasticsearch-dsl'
+project = 'django-opensearch-dsl'
 copyright = ''
 author = 'sabricot and others'
 
@@ -59,7 +59,7 @@
 # built documents.
 #
 # The full version, including alpha/beta/rc tags.
-release = '7.1.1'
+release = '2.0.0'
 # The short X.Y version
 version = ".".join(release.split(".", 3)[:2])
 
@@ -122,7 +122,7 @@
 html_theme_options = {
     'description': 'Using elasticsearch-dsl with Django',
     'github_user': 'sabricot',
-    'github_repo': 'django-elasticsearch-dsl',
+    'github_repo': 'django-opensearch-dsl',
     'github_banner': True}
 
 # Add any paths that contain custom themes here, relative to this directory.
@@ -213,7 +213,7 @@
 #html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-elasticsearch-dsl'
+htmlhelp_basename = 'django-opensearch-dsl'
 
 # -- Options for LaTeX output ---------------------------------------------
 

diff --git a/docs/source/develop.rst b/docs/source/develop.rst
@@ -5,11 +5,11 @@ We are glad to welcome any contributor.
 
 Report bugs or propose enhancements through  `github bug tracker`_
 
-_`github bug tracker`: https://github.com/sabricot/django-elasticsearch-dsl/issues
+_`github bug tracker`: https://github.com/sabricot/django-opensearch-dsl/issues
 
 
 If you want to contribute, the code is on github:
-https://github.com/sabricot/django-elasticsearch-dsl
+https://github.com/sabricot/django-opensearch-dsl
 
 Testing
 =======
@@ -27,7 +27,7 @@ For integration testing with a running Elasticsearch server::
 
 TODO
 ====
- 
+
 - Add support for --using (use another Elasticsearch cluster) in management commands.
 - Add management commands for mapping level operations (like update_mapping....).
 - Generate ObjectField/NestField properties from a Document class.

diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
@@ -7,7 +7,7 @@ Install and configure
 
 Install Django Elasticsearch DSL::
 
-    pip install django-elasticsearch-dsl
+    pip install django-opensearch-dsl
 
 
 Then add ``django_elasticsearch_dsl`` to the INSTALLED_APPS

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 7.1.1
+current_version = 2.0.0
 commit = True
 tag = True
 

diff --git a/setup.py b/setup.py
@@ -8,7 +8,7 @@
 except ImportError:
     from distutils.core import setup
 
-version = '8.0'
+version = '2.0'
 
 if sys.argv[-1] == 'publish':
     try:
@@ -31,19 +31,19 @@
 history = open('HISTORY.rst').read().replace('.. :changelog:', '')
 
 setup(
-    name='django-elasticsearch-dsl',
+    name='django-opensearch-dsl',
     version=version,
     python_requires=">=3.8",
-    description="""Wrapper around elasticsearch-dsl-py for django models""",
+    description="""Wrapper around opensearch-py for django models""",
     long_description=readme + '\n\n' + history,
     author='Sabricot',
-    url='https://github.com/sabricot/django-elasticsearch-dsl',
+    url='https://github.com/nephila/django-opensearch-dsl',
     packages=[
         'django_opensearch_dsl',
     ],
     include_package_data=True,
     install_requires=[
-        'elasticsearch-dsl>=8.9.0,<9.0.0',
+        'opensearch-py>=2.2.0,<2.5.0',
         'six',
     ],
     license="Apache Software License 2.0",