Page MenuHomeSoftware Heritage
Differential D1610 Diff 5550 README.md

Changeset View

Standalone View

View Options

README.md

Show All 12 Lines
- `swh.lister.debian` - `swh.lister.debian`
- `swh.lister.github` - `swh.lister.github`
- `swh.lister.gitlab` - `swh.lister.gitlab`
- `swh.lister.gnu` - `swh.lister.gnu`
- `swh.lister.pypi` - `swh.lister.pypi`
- `swh.lister.npm` - `swh.lister.npm`
- `swh.lister.phabricator` - `swh.lister.phabricator`
- `swh.lister.cran` - `swh.lister.cran`
- `swh.lister.cgit`
Dependencies Dependencies
------------ ------------
All required dependencies can be found in the `requirements*.txt` files located All required dependencies can be found in the `requirements*.txt` files located
at the root of the repository. at the root of the repository.
Local deployment Local deployment
▲ Show 20 Lines • Show All 169 Lines • ▼ Show 20 Lines
```lang=python ```lang=python
import logging import logging
from swh.lister.cran.tasks import cran_lister from swh.lister.cran.tasks import cran_lister
logging.basicConfig(level=logging.DEBUG) logging.basicConfig(level=logging.DEBUG)
cran_lister() cran_lister()
``` ```
## lister-cgit
ardumontUnsubmitted
Done
Inline Actions

I've refrained so far (from telling it again), keep the wrap around please.
That avoids changes from other editors which do respect that (thus
committing extra noise from another diff whose perimeter is not
involved with that part)

ardumont: I've refrained so far (from telling it again), keep the wrap around please. That avoids changes…
nahimilegaAuthorUnsubmitted
Done
Inline Actions

Sorry I forgot about that. I think there is a need to wrap around all the lines in README of lister

nahimilega: Sorry I forgot about that. I think there is a need to wrap around all the lines in README of…
ardumontUnsubmitted
Done
Inline Actions

Sorry I forgot about that.

No worries.

I think there is a need to wrap around all the lines in README of lister

Yes, please, that'd be great.
You can include this in that diff for now (maybe add a commit aside).
TIA

ardumont: > Sorry I forgot about that. No worries. > I think there is a need to wrap around all the…
nahimilegaAuthorUnsubmitted
Done
Inline Actions

I think there is a need to wrap around all the lines in README of lister

Yes, please, that'd be great.
You can include this in that diff for now (maybe add a commit aside).
TIA

I was thinking we can make this a `good first issue `

nahimilega: >>I think there is a need to wrap around all the lines in README of lister >Yes, please…
nahimilegaAuthorUnsubmitted
Done
Inline Actions

@ardumont What do you think about this, shall I create another task regarding this and mark it easy hack or just do it in this diff itself?

nahimilega: @ardumont What do you think about this, shall I create another task regarding this and mark it…
ardumontUnsubmitted
Done
Inline Actions

@vlorentz did T1836, i think ;)

ardumont: @vlorentz did T1836, i think ;)
Once configured, you can execute a cgit lister using the following instructions
in a `python3` script:
```lang=python
import logging
from swh.lister.cgit.tasks import cgit_lister
logging.basicConfig(level=logging.DEBUG)
cgit_lister(url='https://cgit.kde.org/',
ardumontUnsubmitted
Done
Inline Actions

Objectively, the sample is confusing.

If both url and url_prefix are the same, what's the point?
I think you want to change this to either:

  • remove url_prefix from the sample. -> As it's the same as url, no point of exposing it.
  • choose another cgit instance which do need it. -> That has the benefit to demo how to deal with some special cgit instances
  • expose both example, one with only url, another one with both url and url_prefix. -> Benefits of both prior points ;)
ardumont: Objectively, the sample is confusing. If both `url` and `url_prefix` are the same, what's the…
nahimilegaAuthorUnsubmitted
Done
Inline Actions

url and url_prefix are not the same in this case, one ends with git and other with cgit, but I will add more examples where difference is significant.

nahimilega: `url` and `url_prefix` are not the same in this case, one ends with `git` and other with…
ardumontUnsubmitted
Done
Inline Actions

oh, i misread that.

Thanks for making it more apparent!

ardumont: oh, i misread that. Thanks for making it more apparent!
url_prefix='https://anongit.kde.org/')
```
```lang=python
import logging
from swh.lister.cgit.tasks import cgit_lister
logging.basicConfig(level=logging.DEBUG)
cgit_lister(url='https://git.kernel.org/')
```
ardumontUnsubmitted
Done
Inline Actions

Add this within the same previous block comment.
No need for an extra one.

# simple cgit instance
cgit_lister(url='https://git.kernel.org/')
# cgit instance whose listed repositories differ from the base url
cgit_lister(url='https://cgit.kde.org/', url_prefix='https://anongit.kde.org/')
ardumont: Add this within the same previous block comment. No need for an extra one. ``` # simple cgit…
Licensing Licensing
--------- ---------
This program is free software: you can redistribute it and/or modify it under This program is free software: you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free Software the terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later Foundation, either version 3 of the License, or (at your option) any later
version. version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU General Public License for more details. PARTICULAR PURPOSE. See the GNU General Public License for more details.
See top-level LICENSE file for the full text of the GNU General Public License See top-level LICENSE file for the full text of the GNU General Public License
along with this program. along with this program.
About · Developer information · Legal