Rename from API to Http-Client

[AliabbasMerchant]

I'll keep on updating renaming_status.txt.
The file will be deleted before the final merge.

(The module may be unusable while the process of renaming is going on.)

[ntninja]

Thanks for working on this again!
One comment after looking over the first version: Do you really want to rename the root package from ipfsapi to ipfs_http_client? Why not use ipfshttpclient instead, as it is standard python convention?

[AliabbasMerchant]

@daviddias @Alexander255
I have made all changes from my side.
Please have a look at renaming_status.txt
I have marked a few things as doubtful

[ntninja]

Looks mostly good. Please take a look at those CI failures (aside from codestyle). Also please don't create the -ipfshttpclient.* files – just leave them at their original name. Once I merge this I'll take care to split off the previous version into another branch and start working on that compat-shim I talked about.

[AliabbasMerchant]

1. I'll look into the CI failure.
2. I havent renamed any of the files in ipfshttpclient. Just changed the folder name from ipfsapi to ipfshttpclient, and changed the contents of the files.

[ntninja]

I havent renamed any of the files in ipfshttpclient. Just changed the folder name from ipfsapi to ipfshttpclient, and changed the contents of the files.

Then please delete the original files (git rm), commit that and squash your commits. GIT will then detect the files as “renamed with changes” and git blame will continue to work. As I said please also rename the -ipfshttpapi.* files back to their original names.

Thanks for taking the time to work on this and all the work you've already submitted thus far!

[AliabbasMerchant]

@Alexander255 I have renamed the 3 -ipfshttpclient.* files back to their original name and have made changes in them, under the original name itself.
Also, I have squashed all the commits.
With regards to docs/api_ref.md -> docs/http_client_ref.md, no matter what I do, git is considering it as a delete-new_file and not a rename.

[ntninja]

Overall this looks very good! 👍

To fix the merge conflict try (where origin is the name of ipfs/py-ipfs-api repo):

git fetch origin master
git rebase origin/master
git mergetool

In general api_ref.md refers to the API of this module (ie: the interface our users use), but if it's easier to keep it renamed to http_client_ref.md, it won't do any harm either 🙂

One important thing I found during review, however, is that you change the default API endpoint path from api/v0 to http_client/v0 – this is unacceptable as it would make us incompatible with all existing API server implementations for no good reason (it's one of those actually refers to API cases). Other than that I only added some comments regard your comments on URLs and names that will have to be fixed by other (ie: me) – nevermind them.

If you need help getting rid of the merge conflict just leave a comment. Once the conflict is resolved please also try to make the CI happy (except for codestyle never mind that for now).

[AliabbasMerchant]

Ok. I'll do the required changes. Just give me a few days time. I am currently not at home and don't have my laptop. :)

[AliabbasMerchant]

Finally! No conflicts.
The file api_ref.md was successfully renamed to http_client_ref.md
Also, I have changed http_client/v0 to api/v0

[ntninja]

CI found two more issues (mentioned above) that easy to fix. I'm not sure what the the issue is but I think it may go away when I apply one of my planned (read: backward-incompatible) fixes before the release.

Thank you for the work you submitted! It's been quite some help!

[ntninja]

This should be /http_client_okay

[ntninja]

Same here