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

Add documentation #13

Open
oxinabox opened this issue Mar 26, 2021 · 6 comments
Open

Add documentation #13

oxinabox opened this issue Mar 26, 2021 · 6 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@oxinabox
Copy link
Contributor

there are no docs?
Not even a readme?

@mattBrzezinski mattBrzezinski added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 26, 2021
@mattBrzezinski
Copy link
Member

No.

I'm bad for this.

I'll add this in.

@mattBrzezinski mattBrzezinski changed the title docs Add documentation Mar 26, 2021
@oxinabox
Copy link
Contributor Author

oxinabox commented May 6, 2021

I still can't workout how to use this

@mattBrzezinski
Copy link
Member

mattBrzezinski commented May 6, 2021

I still can't workout how to use this

Hehe, one day I will address this. I think at the very least I'll make it in the README. Lets say you want to find all usages of AWS,

You need to specify the name of the package, and which registry it is registered in:

using PkgDeps
users("AWS", "General")

8-element Vector{String}:
 "Zarr"
 "Minio"
 "REDACTED"
 "AWSS3"
 "REDACTED"
 "REDACTED"
 "REDACTED"
 "REDACTED"

This is fine and dandy, but what if you only want to find usages of a package in a specific private registry?

using PkgDeps
invenia = reachable_registries("Invenia")

users("DataFrames", "General"; registries=invenia)

45-element Vector{String}:
 "REDACTED"
 "REDACTED"
 "REDACTED"
 "REDACTED"
 "REDACTED"
 "REDACTED"
 ...

When going by package name you must specify as a second parameter where the package is registered in, as names along are not unique across all registries, see Agents.jl. However, you can instead pass in a UUID instead if you'd like, I actually just tested this and seemed to run into a potential bug though.

@mzgubic
Copy link

mzgubic commented May 10, 2021

thanks for this comment, having a README would be great

@mzgubic
Copy link

mzgubic commented Aug 6, 2021

Is it possible to also see all the packages where PackageA is an indirect dependency?

@mattBrzezinski
Copy link
Member

Is it possible to also see all the packages where PackageA is an indirect dependency?

I don't believe so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants