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.

Sign up for GitHub

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

Jump to bottom

Water down the old ipfsapi library as a thin wrapper around the new ipfshttpclient #152

Merged
merged 16 commits into from
May 13, 2019
Merged

Water down the old ipfsapi library as a thin wrapper around the new ipfshttpclient #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
d898ce6
Defuse `flake8`/`pycodestyle` most annoying “style” checks
ntninja Oct 7, 2018
26d3b23
Restructure the client API based on https://github.com/ipfs/interface…
ntninja Nov 24, 2018
5b398eb
Drop `c.bitswap.unwant` since support for it has been permanently dro…
ntninja Jan 27, 2019
15686cf
Add Python 3.7 to Travis and update to go-IPFS v0.4.18
ntninja Dec 19, 2018
2c11546
Make library a thin wrapper around the newer `ipfshttpclient` library
ntninja Jan 27, 2019
8f9d82c
Convert host + port in `ipfsapi.Client` to MutliAddr for `ipfshttpcli…
ntninja May 13, 2019
06ddc6c
Update unit tests for this new reality of irrelevance
ntninja May 13, 2019
0ee01ab
Fix `IpfsApiTest.test_add_multiple_from_list`
ntninja May 13, 2019
1af7ba8
Drop coverage collection/reporting from this codebase
ntninja May 13, 2019
3277edf
Dynamically intercept all method accesses and rewrite any uses of the…
ntninja May 13, 2019
7e8b402
Repack `PartialErrorResponse` exceptions into incorrect response values
ntninja May 13, 2019
3eb3429
Re-add the broken `bitswap_unwant` and `file_ls` methods
ntninja May 13, 2019
5b39af0
Fix TravisCI build
ntninja May 13, 2019
667f828
Update README regarding deprecation of this package (will be shown on…
ntninja May 13, 2019
4e107a9
Disable request timeouts since the old library also did have them
ntninja May 13, 2019
910d11f
Release version 0.4.4
ntninja May 13, 2019
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
10 changes: 5 additions & 5 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@ matrix:
env: TOXENV=py35
- python: "3.6"
env: TOXENV=py36
- python: "3.6"
env: TOXENV=codestyle
before_install: true
- python: "3.7"
dist: xenial
env: TOXENV=py37

before_install:
- wget "https://dist.ipfs.io/go-ipfs/v0.4.14/go-ipfs_v0.4.14_linux-amd64.tar.gz" -O /tmp/ipfs.tar.gz
- wget "https://dist.ipfs.io/go-ipfs/v0.4.18/go-ipfs_v0.4.18_linux-amd64.tar.gz" -O /tmp/ipfs.tar.gz
- mkdir -p $HOME/bin
- pushd . && cd $HOME/bin && tar -xzvf /tmp/ipfs.tar.gz && popd
- export PATH="$HOME/bin/go-ipfs:$PATH"

install:
- pip install tox

script: tox
script: tox
10 changes: 3 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,14 @@
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![](https://img.shields.io/pypi/v/ipfsapi.svg?style=flat-square)](https://pypi.python.org/pypi/ipfsapi)
[![Build Status](https://travis-ci.org/ipfs/py-ipfs-api.svg?branch=master)](https://travis-ci.org/ipfs/py-ipfs-api)

![Python IPFS HTTP Client Library](https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse)

Check out [the client API reference](https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfsapi/) for the full command reference.
## Deprecation Notice

**Important:** The `py-ipfs-api` PIP package and Python module have both been renamed to `ipfsapi` (no dash, lower-case `a`).
The legacy `ipfs-api`/`ipfsApi` package/module will only work for IPFS 0.3.x and Python 2 and is deprecated. [Please upgrade](#important-changes-from-ipfsapi-02x)!
**Important:** The `ipfsapi` PIP package and Python module have both been renamed to `ipfshttpclient` and this library has been converted into a thin wrapper around that other library. Only critical bug-fixes will be accepted for this package. Please see [migration notes on the new package](https://github.com/ipfs/py-ipfs-http-client/blob/master/README.md#important-changes-from-ipfsapi-04x) for details on how to proceed.

**Note:** This library constantly has to change to stay compatible with the IPFS HTTP API.
Currently, this library is tested against [go-ipfs v0.4.10](https://github.com/ipfs/go-ipfs/releases/tag/v0.4.10).
You may experience compatibility issues when attempting to use it with other versions of go-ipfs.
*The remainder of this README remains as a historical curiousity and will not be updated anymore.*

## Table of Contents

Expand Down
9 changes: 9 additions & 0 deletions ipfsapi/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,15 @@

from __future__ import absolute_import

import warnings
warnings.warn(
"The `ipfsapi` library is deprecated and will stop receiving updates on "
"the 31.12.2019! If you are on Python 3.5+ please enable and fix all "
"Python deprecation warnings (CPython flag `-Wd`) and switch to the new "
"`ipfshttpclient` library name. Python 2.7 and 3.4 will not be supported "
"by the new library, so please upgrade.", FutureWarning, stacklevel=2
)

from .version import __version__

###########################
Expand Down
Loading