Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename package from gnosis-py to safe-eth-py #249

Merged
merged 1 commit into from
May 16, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ jobs:
PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
with:
path-to-signatures: 'signatures/version1/cla.json'
path-to-document: 'https://gnosis-safe.io/cla/'
path-to-document: 'https:/safe.global/cla/'
# branch should not be protected
branch: 'cla-signatures'
allowlist: jpalvarezl,fmrsabino,luarx,rmeissner,Uxio0,*bot # may need to update this expression if we add new bots
allowlist: fmrsabino,luarx,rmeissner,Uxio0,*bot # may need to update this expression if we add new bots

#below are the optional inputs - If the optional inputs are not given, then default values will be taken
#remote-organization-name: enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
Expand Down
30 changes: 15 additions & 15 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
Gnosis-py
#########
Safe-eth-py (previosly known as Gnosis-py)
##########################################

.. class:: no-web no-pdf

|ci| |coveralls| |python| |django| |pipy| |readthedocs| |black|

Gnosis-py includes a set of libraries to work with Ethereum and Gnosis projects:
Safe-eth-py includes a set of libraries to work with Ethereum and relevant Ethereum projects:
- `EthereumClient`, a wrapper over Web3.py `Web3` client including utilities to deal with ERC20/721
tokens and tracing.
- `Gnosis Safe <https://github.com/gnosis/safe-contracts>`_ classes and utilities.
- `Gnosis Safe <https://github.com/safe-global/safe-contracts>`_ classes and utilities.
- Price oracles for `Uniswap`, `Kyber`...
- Django serializers, models and utils.

Quick start
-----------

Just run ``pip install gnosis-py`` or add it to your **requirements.txt**
Just run ``pip install safe-eth-py`` or add it to your **requirements.txt**

If you want django ethereum utils (models, serializers, filters...) you need to run
``pip install gnosis-py[django]``
``pip install safe-eth-py[django]``

If you have issues building **coincurve** maybe
`you are missing some libraries <https://ofek.dev/coincurve/install/#source>`_


Contributing to gnosis-py
Contributing to safe-eth-py
-------------------------
Clone the repo, then to set it up:

Expand Down Expand Up @@ -116,13 +116,13 @@ It includes:

Contributors
------------
`See contributors <https://github.com/gnosis/gnosis-py/graphs/contributors>`_
`See contributors <https://github.com/safe-global/safe-eth-py/graphs/contributors>`_

.. |ci| image:: https://github.com/gnosis/gnosis-py/workflows/Python%20CI/badge.svg?branch=master
.. |ci| image:: https://github.com/safe-global/safe-eth-py/workflows/Python%20CI/badge.svg?branch=master
:alt: Github Actions CI build

.. |coveralls| image:: https://coveralls.io/repos/github/gnosis/gnosis-py/badge.svg?branch=master
:target: https://coveralls.io/github/gnosis/gnosis-py?branch=master
.. |coveralls| image:: https://coveralls.io/repos/github/safe-global/safe-eth-py/badge.svg?branch=master
:target: https://coveralls.io/github/safe-global/safe-eth-py?branch=master
:alt: Coveralls

.. |python| image:: https://img.shields.io/badge/Python-3.9-blue.svg
Expand All @@ -131,12 +131,12 @@ Contributors
.. |django| image:: https://img.shields.io/badge/Django-2-blue.svg
:alt: Django 2.2

.. |pipy| image:: https://badge.fury.io/py/gnosis-py.svg
:target: https://badge.fury.io/py/gnosis-py
.. |pipy| image:: https://badge.fury.io/py/safe-eth-py.svg
:target: https://badge.fury.io/py/safe-eth-py
:alt: Pypi package

.. |readthedocs| image:: https://readthedocs.org/projects/gnosis-py/badge/?version=latest
:target: https://gnosis-py.readthedocs.io/en/latest/?badge=latest
.. |readthedocs| image:: https://readthedocs.org/projects/safe-eth-py/badge/?version=latest
:target: https://safe-eth-py.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

# -- Project information -----------------------------------------------------

project = "Gnosis-Py"
project = "Safe-eth-py"
copyright = "2018-2021, Uxio"
author = "Uxio"

Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.. Gnosis-Py documentation master file, created by
.. safe-eth-py documentation master file, created by
sphinx-quickstart on Fri Jul 9 12:45:20 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Introduction
============

Gnosis-py includes a set of libraries to work with Ethereum and Gnosis projects:
Safe-eth-py includes a set of libraries to work with Ethereum and Gnosis projects:
- `EthereumClient`, a wrapper over Web3.py `Web3` client including utilities to deal with ERC20/721
tokens and tracing.
- `Gnosis Safe <https://github.com/gnosis/safe-contracts>`_ classes and utilities.
- `Gnosis Safe <https://github.com/safe-global/safe-contracts>`_ classes and utilities.
- Price oracles for `Uniswap`, `Kyber`...
- Django serializers, models and utils.

Expand Down
6 changes: 3 additions & 3 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Quick start
-----------

Just run ``pip install gnosis-py`` or add it to your **requirements.txt**
Just run ``pip install safe-eth-py`` or add it to your **requirements.txt**

If you want django ethereum utils (models, serializers, filters...) you need to run
``pip install gnosis-py[django]``
``pip install safe-eth-py[django]``

If you have issues building **coincurve** maybe
`you are missing some libraries <https://ofek.dev/coincurve/install/#source>`_
Expand Down Expand Up @@ -121,7 +121,7 @@ Gnosis Products
---------------
Safe
~~~~
On ``gnosis.safe`` there're classes to work with `Gnosis Safe <https://gnosis-safe.io/>`_
On ``gnosis.safe`` there're classes to work with `Gnosis Safe <https://safe.global/>`_

.. code-block:: python

Expand Down
2 changes: 1 addition & 1 deletion gnosis/eth/contracts/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Safe Addresses. Should be the same for every chain except for the ones with `chainId` protection. Check:
https://github.com/gnosis/safe-deployments/tree/main/src/assets
https://github.com/safe-global/safe-deployments/tree/main/src/assets

GnosisSafe V1.3.0: 0xd9Db270c1B5E3Bd161E8c8503c55cEABeE709552
GnosisSafe V1.1.1: 0x34CfAC646f301356fAa8B21e94227e3583Fe3F5F
Expand Down
2 changes: 1 addition & 1 deletion gnosis/safe/safe_tx.py
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ def w3_tx(self):

def _raise_safe_vm_exception(self, message: str) -> NoReturn:
error_with_exception: Dict[str, Type[InvalidMultisigTx]] = {
# https://github.com/gnosis/safe-contracts/blob/v1.3.0/docs/error_codes.md
# https://github.com/safe-global/safe-contracts/blob/v1.3.0/docs/error_codes.md
"GS000": CouldNotFinishInitialization,
"GS001": ThresholdNeedsToBeDefined,
"Could not pay gas costs with ether": CouldNotPayGasWithEther,
Expand Down
8 changes: 5 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
extras_require = {"django": ["django>=2", "django-filter>=2", "djangorestframework>=2"]}

setup(
name="gnosis-py",
version="3.9.4",
name="safe-eth-py",
version="4.0.0",
packages=find_packages(),
package_data={"gnosis": ["py.typed"]},
install_requires=requirements,
Expand All @@ -32,14 +32,16 @@
license="MIT License",
description="Gnosis libraries for Python Projects",
long_description=README,
url="https://github.com/gnosis/gnosis-py",
url="https://github.com/safe-global/safe-eth-py",
author="Uxío",
author_email="uxio@gnosis.pm",
keywords=["ethereum", "web3", "django", "rest", "gnosis"],
classifiers=[
"Environment :: Web Environment",
"Framework :: Django",
"Framework :: Django :: 2.0",
"Framework :: Django :: 3.0",
"Framework :: Django :: 4.0",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
Expand Down