Skip to content

Commit

Permalink
chore: remove all references to gee_tools
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Feb 4, 2024
1 parent 23d8f57 commit 91f0001
Show file tree
Hide file tree
Showing 14 changed files with 25 additions and 25 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/<YOUR USERNAME>/gee_tools
cd gee_tools
git clone https://github.com/<YOUR USERNAME>/geetools
cd geetools
Then install the development version of the extension:

Expand Down Expand Up @@ -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 <https://github.com/gee-community/gee_tools/blob/main/RELEASE.rst>`__ 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 <https://github.com/gee-community/geetools/blob/main/RELEASE.rst>`__ and follow the presented workflow.

Once you are done you can close the issue and celebrate!
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions RELEASE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand All @@ -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).
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
{
Expand All @@ -67,7 +67,7 @@
}
html_context = {
"github_user": "gee-community",
"github_repo": "gee_tools",
"github_repo": "geetools",
"github_version": "master",
"doc_path": "docs",
}
Expand Down
4 changes: 2 additions & 2 deletions docs/example/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Add a new example
:align: center

Currently most of the examples built by `@Rodrigo <https://github.com/fitoprincipe>`__ are still using the old implementation of the library.
They should be transformed into modern example and moved from the old `notebook <https://github.com/gee-community/gee_tools/tree/main/notebooks>`__ folder to the new `example <https://github.com/gee-community/gee_tools/tree/main/docs/example>`__ one to be displayed in our doc.
They should be transformed into modern example and moved from the old `notebook <https://github.com/gee-community/geetools/tree/main/notebooks>`__ folder to the new `example <https://github.com/gee-community/geetools/tree/main/docs/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 <https://github.com/gee-community/gee_tools/tree/main/docs/example/template.ipynb>`__ and replace things with your code.
To add a new example, you can use the `example template <https://github.com/gee-community/geetools/tree/main/docs/example/template.ipynb>`__ and replace things with your code.

Then you can open a PR with the new file and it will be reviewed and merged.

Expand Down
2 changes: 1 addition & 1 deletion docs/example/template.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ geetools
usage/index
example/index
autoapi/index
Changelogs <https://github.com/gee-community/gee_tools/releases>
Changelogs <https://github.com/gee-community/geetools/releases>
earth-engine API <https://developers.google.com/earth-engine/apidocs>

Overview
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/gee-community/gee_tools/issues/new>`__.
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 <https://github.com/gee-community/geetools/issues/new>`__.

.. toctree::
:hidden:
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/layout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/gee-community/gee_tools/issues/new>`__.
If you have a problem that is not listed here, please open an item in our `issue tracker <https://github.com/gee-community/geetools/issues/new>`__.


Import the modules
Expand Down
2 changes: 1 addition & 1 deletion geetools/Array/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion geetools/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" = [
Expand Down

1 comment on commit 91f0001

@12rambau
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix #117

Please sign in to comment.