path: root/python-tranco.spec

%global _empty_manifest_terminate_build 0
Name:		python-tranco
Version:	0.6
Release:	1
Summary:	Tranco: A Research-Oriented Top Sites Ranking Hardened Against Manipulation
License:	MIT License
URL:		https://github.com/DistriNet/tranco-python-package
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/ae/02/466891cb4d0ba06a25428345e3e047e243510c2aeb49a8b0da444dd9aa31/tranco-0.6.tar.gz
BuildArch:	noarch

Requires:	python3-requests

%description
# Tranco

This package allows easy access to the Tranco list, published at [https://tranco-list.eu](https://tranco-list.eu/).

## Usage

Create a `Tranco` object, indicating whether you want to cache downloaded lists:
```python
from tranco import Tranco
t = Tranco(cache=True, cache_dir='.tranco')
```

You can then retrieve lists from this object using the `list` method:

```python
latest_list = t.list()
date_list = t.list(date='2019-02-25')
```

This method returns a `TrancoList`, which allows you to retrieve a certain prefix of the list (`top`), 
the list ID (`list_id`), the list page (`list_page`) or the rank of a domain (`rank`):
```python
latest_list.top(10000)
latest_list.list_id
latest_list.list_page
latest_list.rank("google.com")
latest_list.rank("not.in.ranking") # returns -1
```

You can also generate custom lists. 
First, create a `Tranco` object with valid credentials 
(available from your [account page](https://tranco-list.eu/account)):
```python
from tranco import Tranco
t = Tranco(account_email="abc@xyz.eu", api_key="123ABC")
```

Then, pass the configuration (according to [this schema](https://tranco-list.eu/api_documentation#datatypes-configuration))
of your custom list to `configure`:
```python
c = t.configure(
    {
        'providers': ['alexa', 'umbrella', 'majestic'],
        'startDate': '2021-01-01',
        'endDate': '2021-01-30',
        'combinationMethod': 'dowdall',
        'listPrefix': 'full',
        'filterPLD': 'on',
    }
)
```
This method returns a tuple: whether the list is already available or is still being generated, 
and the ID that has been/will be assigned to the list.

You can retrieve metadata for a list through `list_metadata`:
```python
m = t.list_metadata(list_id="6P7X")
```
If a list is still being generated, you can use this method to track the progress; 
once a list has been generated, this metadata will indicate how the list was configured.




%package -n python3-tranco
Summary:	Tranco: A Research-Oriented Top Sites Ranking Hardened Against Manipulation
Provides:	python-tranco
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-tranco
# Tranco

This package allows easy access to the Tranco list, published at [https://tranco-list.eu](https://tranco-list.eu/).

## Usage

Create a `Tranco` object, indicating whether you want to cache downloaded lists:
```python
from tranco import Tranco
t = Tranco(cache=True, cache_dir='.tranco')
```

You can then retrieve lists from this object using the `list` method:

```python
latest_list = t.list()
date_list = t.list(date='2019-02-25')
```

This method returns a `TrancoList`, which allows you to retrieve a certain prefix of the list (`top`), 
the list ID (`list_id`), the list page (`list_page`) or the rank of a domain (`rank`):
```python
latest_list.top(10000)
latest_list.list_id
latest_list.list_page
latest_list.rank("google.com")
latest_list.rank("not.in.ranking") # returns -1
```

You can also generate custom lists. 
First, create a `Tranco` object with valid credentials 
(available from your [account page](https://tranco-list.eu/account)):
```python
from tranco import Tranco
t = Tranco(account_email="abc@xyz.eu", api_key="123ABC")
```

Then, pass the configuration (according to [this schema](https://tranco-list.eu/api_documentation#datatypes-configuration))
of your custom list to `configure`:
```python
c = t.configure(
    {
        'providers': ['alexa', 'umbrella', 'majestic'],
        'startDate': '2021-01-01',
        'endDate': '2021-01-30',
        'combinationMethod': 'dowdall',
        'listPrefix': 'full',
        'filterPLD': 'on',
    }
)
```
This method returns a tuple: whether the list is already available or is still being generated, 
and the ID that has been/will be assigned to the list.

You can retrieve metadata for a list through `list_metadata`:
```python
m = t.list_metadata(list_id="6P7X")
```
If a list is still being generated, you can use this method to track the progress; 
once a list has been generated, this metadata will indicate how the list was configured.




%package help
Summary:	Development documents and examples for tranco
Provides:	python3-tranco-doc
%description help
# Tranco

This package allows easy access to the Tranco list, published at [https://tranco-list.eu](https://tranco-list.eu/).

## Usage

Create a `Tranco` object, indicating whether you want to cache downloaded lists:
```python
from tranco import Tranco
t = Tranco(cache=True, cache_dir='.tranco')
```

You can then retrieve lists from this object using the `list` method:

```python
latest_list = t.list()
date_list = t.list(date='2019-02-25')
```

This method returns a `TrancoList`, which allows you to retrieve a certain prefix of the list (`top`), 
the list ID (`list_id`), the list page (`list_page`) or the rank of a domain (`rank`):
```python
latest_list.top(10000)
latest_list.list_id
latest_list.list_page
latest_list.rank("google.com")
latest_list.rank("not.in.ranking") # returns -1
```

You can also generate custom lists. 
First, create a `Tranco` object with valid credentials 
(available from your [account page](https://tranco-list.eu/account)):
```python
from tranco import Tranco
t = Tranco(account_email="abc@xyz.eu", api_key="123ABC")
```

Then, pass the configuration (according to [this schema](https://tranco-list.eu/api_documentation#datatypes-configuration))
of your custom list to `configure`:
```python
c = t.configure(
    {
        'providers': ['alexa', 'umbrella', 'majestic'],
        'startDate': '2021-01-01',
        'endDate': '2021-01-30',
        'combinationMethod': 'dowdall',
        'listPrefix': 'full',
        'filterPLD': 'on',
    }
)
```
This method returns a tuple: whether the list is already available or is still being generated, 
and the ID that has been/will be assigned to the list.

You can retrieve metadata for a list through `list_metadata`:
```python
m = t.list_metadata(list_id="6P7X")
```
If a list is still being generated, you can use this method to track the progress; 
once a list has been generated, this metadata will indicate how the list was configured.




%prep
%autosetup -n tranco-0.6

%build
%py3_build

%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .

%files -n python3-tranco -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6-1
- Package Spec generated