From 91f000145d32fa1cb777c13431ca017c4ce19708 Mon Sep 17 00:00:00 2001 From: Pierrick Rambaud Date: Sun, 4 Feb 2024 22:27:33 +0100 Subject: [PATCH] chore: remove all references to gee_tools --- CONTRIBUTING.rst | 6 +++--- README.rst | 8 ++++---- RELEASE.rst | 8 ++++---- docs/conf.py | 4 ++-- docs/example/index.rst | 4 ++-- docs/example/template.ipynb | 2 +- docs/index.rst | 2 +- docs/usage/index.rst | 2 +- docs/usage/install.rst | 4 ++-- docs/usage/layout.rst | 2 +- docs/usage/migration.rst | 2 +- geetools/Array/__init__.py | 2 +- geetools/__init__.py | 2 +- pyproject.toml | 2 +- 14 files changed, 25 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4b86ae06..f0e8dddb 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -45,8 +45,8 @@ Then, clone the repository locally so that you have a local copy to work on: .. code-block:: console - git clone https://github.com//gee_tools - cd gee_tools + git clone https://github.com//geetools + cd geetools Then install the development version of the extension: @@ -101,6 +101,6 @@ Release new version Only maintainers can release new versions of **geetools**. -To release a new version, open an issue with the new version number e.g. ``RLS: 1.0.0``. copy/paste the instructions from the `release instructions `__ and follow the presented workflow. +To release a new version, open an issue with the new version number e.g. ``RLS: 1.0.0``. copy/paste the instructions from the `release instructions `__ and follow the presented workflow. Once you are done you can close the issue and celebrate! diff --git a/README.rst b/README.rst index 2196e01f..b98348df 100644 --- a/README.rst +++ b/README.rst @@ -31,12 +31,12 @@ geetools :target: https://pypi.org/project/geetools/ :alt: PyPI version -.. image:: https://img.shields.io/github/actions/workflow/status/gee-community/gee_tools/unit.yaml?logo=github&logoColor=white - :target: https://github.com/gee-community/gee_tools/actions/workflows/unit.yaml +.. image:: https://img.shields.io/github/actions/workflow/status/gee-community/geetools/unit.yaml?logo=github&logoColor=white + :target: https://github.com/gee-community/geetools/actions/workflows/unit.yaml :alt: build -.. image:: https://img.shields.io/codecov/c/github/gee-community/gee_tools?logo=codecov&logoColor=white - :target: https://codecov.io/gh/gee-community/gee_tools +.. image:: https://img.shields.io/codecov/c/github/gee-community/geetools?logo=codecov&logoColor=white + :target: https://codecov.io/gh/gee-community/geetools :alt: Test Coverage .. image:: https://img.shields.io/readthedocs/gee-tools?logo=readthedocs&logoColor=white diff --git a/RELEASE.rst b/RELEASE.rst index 0a706208..28565e44 100644 --- a/RELEASE.rst +++ b/RELEASE.rst @@ -11,7 +11,7 @@ These steps should be taken in order to create a new release! **Double check for quality-control** - - [ ] There are no [open issues with a `impact: block-release` label](https://github.com/gee-community/gee_tools/labels/impact%3A%20block-release) + - [ ] There are no [open issues with a `impact: block-release` label](https://github.com/gee-community/geetools/labels/impact%3A%20block-release) **Prepare the codebase for a new version** @@ -21,15 +21,15 @@ These steps should be taken in order to create a new release! **Make the release** - - [ ] [Start a new GitHub release](https://github.com/gee-community/gee_tools/releases/new) + - [ ] [Start a new GitHub release](https://github.com/gee-community/geetools/releases/new) - Call the release the current version, e.g. `v0.2.0` - In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag" - In the **`Target:`** dropdown, pin it to the release commit that you've just pushed. - Generate the automatic release notes, eventually manually specify the previous version (useful when several release candidate have been made) - [ ] Confirm that the release completed - - [The `publish` github action job](https://github.com/gee-community/gee_tools/actions/workflows/release.yaml) has completed successfully in the [actions tab](https://github.com/gee-community/gee_tools/actions). + - [The `publish` github action job](https://github.com/gee-community/geetools/actions/workflows/release.yaml) has completed successfully in the [actions tab](https://github.com/gee-community/geetools/actions). - [The PyPI version is updated](https://pypi.org/project/geetools/) - [ ] Hide the previous patch version build in the RDT interface if needed. - [ ] Celebrate, you're done! - Taken from [the release checklist](https://github.com/gee-community/gee_tools/blob/main/RELEASE.rst). + Taken from [the release checklist](https://github.com/gee-community/geetools/blob/main/RELEASE.rst). diff --git a/docs/conf.py b/docs/conf.py index e1c9ec0c..b167ac64 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,7 +51,7 @@ "icon_links": [ { "name": "GitHub", - "url": "https://github.com/gee-community/gee_tools", + "url": "https://github.com/gee-community/geetools", "icon": "fa-brands fa-github", }, { @@ -67,7 +67,7 @@ } html_context = { "github_user": "gee-community", - "github_repo": "gee_tools", + "github_repo": "geetools", "github_version": "master", "doc_path": "docs", } diff --git a/docs/example/index.rst b/docs/example/index.rst index 5f6c214e..704e916e 100644 --- a/docs/example/index.rst +++ b/docs/example/index.rst @@ -20,11 +20,11 @@ Add a new example :align: center Currently most of the examples built by `@Rodrigo `__ are still using the old implementation of the library. -They should be transformed into modern example and moved from the old `notebook `__ folder to the new `example `__ one to be displayed in our doc. +They should be transformed into modern example and moved from the old `notebook `__ folder to the new `example `__ one to be displayed in our doc. The examples are regular notebook files that are interpreted by the nbsphinx lib and displayed in the doc, clicking on the :guilabel:`open in colab` button will open a colab notebook with the code ready to be executed and the :guilabel:`view source` will bring you back to github. -To add a new example, you can use the `example template `__ and replace things with your code. +To add a new example, you can use the `example template `__ and replace things with your code. Then you can open a PR with the new file and it will be reviewed and merged. diff --git a/docs/example/template.ipynb b/docs/example/template.ipynb index 0940de85..428d3dc0 100644 --- a/docs/example/template.ipynb +++ b/docs/example/template.ipynb @@ -11,7 +11,7 @@ "cell_type": "markdown", "metadata": {}, "source": [ - "[![github](https://img.shields.io/badge/-see%20sources-white?logo=github&labelColor=555)](https://github.com/gee_community/gee_tools/blob/main/docs/example/template.ipynb)\n", + "[![github](https://img.shields.io/badge/-see%20sources-white?logo=github&labelColor=555)](https://github.com/gee_community/geetools/blob/main/docs/example/template.ipynb)\n", "[![colab](https://img.shields.io/badge/-open%20in%20colab-blue?logo=googlecolab&labelColor=555)](https://colab.research.google.com/github/gee_community/gee_tools/blob/main/docs/example/template.ipynb)" ] }, diff --git a/docs/index.rst b/docs/index.rst index f9f26d0e..59634558 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ geetools usage/index example/index autoapi/index - Changelogs + Changelogs earth-engine API Overview diff --git a/docs/usage/index.rst b/docs/usage/index.rst index 4bf8fab6..75f60450 100644 --- a/docs/usage/index.rst +++ b/docs/usage/index.rst @@ -17,7 +17,7 @@ Since version v1.0.0, the package has been drastically modified to adopt the ext .. important:: - The refactoring process is not finished yet, we will progressively reintegrate all the methods in the new pattern and add many cool functionalities. If any of your previous is not working anymore and the :doc:`migration` page did not provided any solution, please open an issue in the `GitHub repository `__. + The refactoring process is not finished yet, we will progressively reintegrate all the methods in the new pattern and add many cool functionalities. If any of your previous is not working anymore and the :doc:`migration` page did not provided any solution, please open an issue in the `GitHub repository `__. .. toctree:: :hidden: diff --git a/docs/usage/install.rst b/docs/usage/install.rst index 4c9dab28..64bab616 100644 --- a/docs/usage/install.rst +++ b/docs/usage/install.rst @@ -27,13 +27,13 @@ You can also install the package from source. First clone the repository: .. code-block:: console - git clone https://github.com/gee-community/gee_tools.git + git clone https://github.com/gee-community/geetools.git Then, navigate to the folder and install the package using pip: .. code-block:: console - cd gee_tools + cd geetools pip install . Multiple version of the package requirements are available and are specifically important for local development. diff --git a/docs/usage/layout.rst b/docs/usage/layout.rst index 942580fb..e612ca11 100644 --- a/docs/usage/layout.rst +++ b/docs/usage/layout.rst @@ -20,7 +20,7 @@ Earth Engine classes ee.Array ^^^^^^^^ -As reported in https://github.com/gee-community/gee_tools/issues/173, this object cannot be extended before the API of Earth Enfine is initialized. So to use the following methods, you will be forced to manually import the following: +As reported in https://github.com/gee-community/geetools/issues/173, this object cannot be extended before the API of Earth Enfine is initialized. So to use the following methods, you will be forced to manually import the following: .. code-block:: python diff --git a/docs/usage/migration.rst b/docs/usage/migration.rst index 93251822..30dcbe11 100644 --- a/docs/usage/migration.rst +++ b/docs/usage/migration.rst @@ -12,7 +12,7 @@ None the less, as previous implementation was leading to internal issues such as .. warning:: This documentation is gathering problems faced by the community and the solutions that were found. - If you have a problem that is not listed here, please open an item in our `issue tracker `__. + If you have a problem that is not listed here, please open an item in our `issue tracker `__. Import the modules diff --git a/geetools/Array/__init__.py b/geetools/Array/__init__.py index e1c701bc..b8fa215d 100644 --- a/geetools/Array/__init__.py +++ b/geetools/Array/__init__.py @@ -2,7 +2,7 @@ .. warning:: - As reported in https://github.com/gee-community/gee_tools/issues/173, this object cannot be extended before the API of + As reported in https://github.com/gee-community/geetools/issues/173, this object cannot be extended before the API of Earth Enfine is initialized. So to use the following methods, you will be forced to manually import the following: .. code-block:: python diff --git a/geetools/__init__.py b/geetools/__init__.py index 31984d9d..83ea317a 100644 --- a/geetools/__init__.py +++ b/geetools/__init__.py @@ -48,7 +48,7 @@ from .Authenticate import AuthenticateAccessor # Array cannot be imported directly in geetools prior to Initialisation -# waiting for a fix in https://github.com/gee-community/gee_tools/issues/173 +# waiting for a fix in https://github.com/gee-community/geetools/issues/173 # from .Array import Array diff --git a/pyproject.toml b/pyproject.toml index 89139a9f..c2e53269 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,7 @@ file = "README.rst" content-type = "text/x-rst" [project.urls] -Homepage = "https://github.com/gee-community/gee_tools" +Homepage = "https://github.com/gee-community/geetools" [project.optional-dependencies] "dev" = [