audeering / audfactory

Communicating with Artifactory
https://audeering.github.io/audfactory/
Other
0 stars 0 forks source link

Is current API ok? #6

Closed hagenw closed 3 years ago

hagenw commented 3 years ago

The current master is the release candidate for version 1.0.0 of audfactory. Would be nice to check if you agree with the currently proposed API. To check you need to compile the documentation locally.

Here is a summary of all the changes compared to version 0.8.1:

frankenjoe commented 3 years ago

Unfortunately, I cound't figure out how get a user name and password for https://audeering.jfrog.io/artifactory, so I couldn't really test any code. But I have built the documentation and I think it looks good! I only have few comments:

image

image

hagenw commented 3 years ago

The good news is you accessed https://audeering.jfrog.io/artifactory already. Building the documentation is accessing the data-public repository which has anonymous access.

For the other one you need to add an additional entry to ~/.artifactory_python.cfg and I will create a user account for you. Not sure yet where we document this.

hagenw commented 3 years ago

I renamed audfactory.server_url() to audfactory.url() and took the opportunity to do the same with audfactory.artifactory_path(), audfactory.deploy_artifact() and audfactory.download_artifact().

I didn't use :mod: in the README as the README should also look nice on Github.

I fixed the link to audeer.is_semantic_version()