Skip to content
This repository has been archived by the owner on Jan 13, 2023. It is now read-only.

PyOTA v2.0.4
Compare
Choose a tag to compare
@todofixthis todofixthis released this 26 Jan 23:06
· 315 commits to master since this release
2.0.4
540668b
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

⚠️ This release contains a few changes that may be backwards-incompatible, depending on how your application is configured. Check the Backwards-Incompatible Changes section for more information! ⚠️

Backwards-Incompatible Changes

Renamed CLI Command

The iota-cli command has been renamed to pyota-cli, to avoid conflicts with the cli-app project.

If PyOTA is already installed, the iota-cli command will continue to work (the pyota-cli command will be installed alongside it). However, if you install PyOTA into a new virtualenv, it will not install the iota-cli command, only pyota-cli!

Deprecated Methods

The following methods now emit a DeprecationWarning when invoked. Depending on how your application is configured, these warnings may be converted into exceptions.

  • TryteString.as_bytes() (use TryteString.encode() instead).
  • TryteString.as_string() (use TryteString.decode() instead).
  • TryteString.from_string() (use TryteString.from_unicode() instead).

To resolve the DeprecationWarning, replace usages of the deprecated methods with the replacement versions as noted above.

Tip: After making this change, your application will no longer be compatible with PyOTA <= 2.0.4; it is recommended that you also add pyota >= 2.0.4 to your project's setup.py or requirements.txt file!

If your application does not use any of the methods listed above, no action is required.

Changelog

  • (#121) Added is_promotable and promote_transaction API methods (thanks @scottbelden!).
  • (#38) Added is_reattachable API method (thanks @jinnerbichler!).
  • (#122) Rename iota-cli command to prevent conflict with cli-app project (thanks @plenarius!).
  • (#129) Added authentication argument to HttpAdapter (thanks @HerrMuellerluedenscheid!).
  • (#105) Added timeout argument to HttpAdapter (thanks @jinnerbichler!).
  • (#111) add_neighbor and remove_neighbor now also accept URIs that start with tcp:// (thanks @danielfaust for reporting!).
  • (#92) Added offset and length arguments to PyCurl methods (thanks @mlouielu!).
  • (#90) Renamed the following methods:
    • TryteString.as_bytes() => TryteString.encode()
    • TryteString.as_string() => TryteString.decode()
    • TryteString.from_string() => TryteString.from_unicode()
  • (#130) Fixed incorrect type in get_tips response (thanks @za-uz for reporting!)
  • (#120) Fixed references to "standard" API in the documentation (thanks @rpitonak!).
  • Added helpers namespace to Iota (thanks @scottbelden!).
  • Added missing fields in transaction documentation (thanks @GalRogozinski!).
  • Made examples/send_transfer.py easier to read (thanks @maeck70!).
  • Added new setuptools extra "test-runner", to install detox.
    • Added more information about running unit tests to README.rst.
  • Added metadata check to the build process and fixed invalid syntax in README.rst.
  • Fixed incorrect type hint for find_transaction_objects.
  • Changed link in README.rst from Slack to Discord.

Special Thanks

Thank you to everyone who helped make this release a success!

And to the entire PyOTA community! Seriously, you guys rock!

Signature/Checksums

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

# PyOTA v2.0.4

**⚠️ This release contains a few changes that may be backwards-incompatible, depending on how your application is configured.  Check the Backwards-Incompatible Changes section for more information! ⚠️**

## Backwards-Incompatible Changes
### Renamed CLI Command
The `iota-cli` command has been renamed to `pyota-cli`, to avoid conflicts with the [cli-app](https://github.com/iotaledger/cli-app/blob/v1.0.8/package.json#L31) project.

If PyOTA is already installed, the `iota-cli` command will continue to work (the `pyota-cli` command will be installed alongside it).  However, if you install PyOTA into a new virtualenv, it will **not** install the `iota-cli` command, only `pyota-cli`!

### Deprecated Methods
The following methods now emit a `DeprecationWarning` when invoked.  Depending on how your application is configured, these warnings may be converted into exceptions.

* `TryteString.as_bytes()` (use `TryteString.encode()` instead).
* `TryteString.as_string()` (use `TryteString.decode()` instead).
* `TryteString.from_string()` (use `TryteString.from_unicode()` instead).

To resolve the `DeprecationWarning`, replace usages of the deprecated methods with the replacement versions as noted above.

**Tip: After making this change, your application will no longer be compatible with PyOTA < 2.0.4; it is recommended that you also add `pyota >= 2.0.4` to your project's `setup.py` or `requirements.txt` file!**

If your application does not use any of the methods listed above, no action is required.

## Changelog
* (#121) Added `is_promotable` and `promote_transaction` API methods (thanks [@scottbelden]!).
* (#38) Added `is_reattachable` API method (thanks [@jinnerbichler]!).
* (#122) Rename `iota-cli` command to prevent conflict with `cli-app` project (thanks [@plenarius]!).
* (#129) Added `authentication` argument to `HttpAdapter` (thanks [@HerrMuellerluedenscheid]!).
* (#105) Added `timeout` argument to `HttpAdapter` (thanks [@jinnerbichler]!).
* (#111) `add_neighbor` and `remove_neighbor` now also accept URIs that start with `tcp://` (thanks [@danielfaust] for reporting!).
* (#92) Added `offset` and `length` arguments to PyCurl methods (thanks [@mlouielu]!).
* (#90) Renamed the following methods:
    * `TryteString.as_bytes()` => `TryteString.encode()`
    * `TryteString.as_string()` => `TryteString.decode()`
    * `TryteString.from_string()` => `TryteString.from_unicode()`
* (#130) Fixed incorrect type in `get_tips` response (thanks [@za-uz] for reporting!)
* (#120) Fixed references to "standard" API in the documentation (thanks [@rpitonak]!).
* Added `helpers` namespace to `Iota` (thanks [@scottbelden]!).
* Added missing fields in transaction documentation (thanks [@GalRogozinski]!).
* Made `examples/send_transfer.py` easier to read (thanks [@maeck70]!).
* Added new setuptools extra "`test-runner`", to install [detox](https://pypi.python.org/pypi/detox).
    * Added more information about running unit tests to `README.rst`.
* Added metadata check to the build process and fixed invalid syntax in `README.rst`.
    * This should also fix rendering issues on [PyOTA's PyPI page](https://pypi.python.org/pypi/PyOTA).
* Fixed incorrect type hint for `find_transaction_objects`.
* Changed link in `README.rst` from Slack to Discord.

## Special Thanks
Thank you to everyone who helped make this release a success!

* [@danielfaust]
* [@GalRogozinski]
* [@HerrMuellerluedenscheid]
* [@jinnerbichler]
* [@maeck70]
* [@mlouielu]
* [@plenarius]
* [@rpitonak]
* [@scottbelden]
* [@za-uz]

And to the entire PyOTA community!  Seriously, you guys rock!


  [@danielfaust]: https://github.com/danielfaust
  [@GalRogozinski]: https://github.com/GalRogozinski
  [@HerrMuellerluedenscheid]: https://github.com/HerrMuellerluedenscheid
  [@jinnerbichler]: https://github.com/jinnerbichler
  [@maeck70]: https://github.com/maeck70
  [@mlouielu]: https://github.com/mlouielu
  [@plenarius]: https://github.com/plenarius
  [@rpitonak]: https://github.com/rpitonak
  [@scottbelden]: https://github.com/scottbelden
  [@za-uz]: https://github.com/za-uz

# Binary Distribution Checksums
* PyOTA-2.0.4-py2.py3-none-any.whl
    * sha256: f292408e9f4d98cceef6a04262ce074cf021936705d2f9f34cd38db49d25cea5
    * md5: 306c38ffea5ac4cd4c5c905225ff129e
* PyOTA-2.0.4.tar.gz
    * sha256: ace8454fd06252a76dc52fa09c94fd38ad78dc5cebd2ae4ab41ad4e26badaaa3
    * md5: a8cb576ef8d843b0f4de400d6174e947
-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEc9vOP4UernObqSUWjIY/jl7U00MFAlprtDIACgkQjIY/jl7U
00O9CQ//bFlgudszjjn3lnYV31Pe/L9lQFS4t9BwJUrfRPzgA+RgKWXJjBAVPBx6
i58RCaSkq9TLtp8kVe7ltlQsM+eN2gXuaue9zaskiSGqnvNBl/BfKstIEB6Cf2LS
Kjjy3euqFaFm3Nu4Ku2GP78CId2y8kKVnp2qPDNT52i0kLy1Yyx8yiQFsj3c2czh
b/pmHPhIDcYYN9P9ThncIulOsalLQ/38C6lxxZyZZYkaiuNFxnlSn4qrS7v0ktWT
bEj0UmFtL462M/MUkCExrlCpov79WmIrL7E/3QZqa1j96U9eePIYLFGXG9zbm+N8
Fk+Czcj2OZd2sPouVu6fpS1mHmIbJvhUN85aGeTSMWDLccaxJZH1ow4Sq/zNWimO
tMcftiUWzjwO3CB6SOna3xHwUPT0gAklbCGzPEI9UUplV9K74m4EHKQqAuJ5GmN9
h6TDcR9jUaf1jXk8jMSUKZ0i8Xw/VsLwVZL3iSijwHpydXoOj2jCtzhh24x1XvPY
ZMjT6DkxmZsJBSeFTvv06Jblloc6B/UQsYKTKbRNKS62wjzuv83R7nFxamOXVTxD
Jk2+S+nR2V1nK8wIvYpxA+XfOB6Q0LGYw6leJfOOwP3kKNK5WrCOkckBCuQKj3A2
Z0MY8vDQtw/n5aRa6zQgrOLkYWfb2A4iGsW+bERUy64bgnaXFtc=
=x4WB
-----END PGP SIGNATURE-----
Assets 4
Loading