search

carlmontanari / scrapli

Fast, flexible, sync/async, Python 3.7+ screen scraping client specifically for network devices
https://carlmontanari.github.io/scrapli/
MIT License
575 stars 59 forks source link

Possible change to docs #310

Closed exe-r closed 8 months ago

exe-r commented 10 months ago

Describe the bug Hello, thanks for the great project, I am quite new to this. Wanted to ask regarding this part of the doc

Is this still relevant? I tried to install it on a new machine but i get the following:

pip3 install scrapli[full]
Requirement already satisfied: scrapli[full] in ./.local/lib/python3.9/site-packages (2023.7.30)
WARNING: scrapli 2023.7.30 does not provide the extra 'full'

My understanding is there are only these packages available and the following transports available but "system" is the OS ssh client and "full" should not exist as extra package, the rest can be correctly install as .i.e. pip install scrapli[paramiko] etc

Thanks in advance

carlmontanari commented 10 months ago

hmm... I think full must have got killed off in the migration to pyproject.toml... my bad :)

these should all work (like pip install scrapli[community] etc.) still.

I suspect we could fairly easily add full back in in the pyproject.toml -- worst case maybe that means having a requirements-full.txt and adding a line like the above linked stuff; but would be nicer if there is a way to do it w/out adding that file (I'm just not sure off the top of my head). would you be up for a pr to get this sorted out?

edit and/or a pr to docs would be cool too if you're up for it, either way :)

exe-r commented 10 months ago

hmm... I think full must have got killed off in the migration to pyproject.toml... my bad :)

these should all work (like pip install scrapli[community] etc.) still.

I suspect we could fairly easily add full back in in the pyproject.toml -- worst case maybe that means having a requirements-full.txt and adding a line like the above linked stuff; but would be nicer if there is a way to do it w/out adding that file (I'm just not sure off the top of my head). would you be up for a pr to get this sorted out?

edit and/or a pr to docs would be cool too if you're up for it, either way :)

Thanks for the quick reply, that would be a great opportunity to start contributing ! Let me have a look and have a go with a pr

carlmontanari commented 8 months ago

ill go ahead and close this for now, but defo feel free to pop back w/ any doc update prs at any time, they are much appreciated!