Skip to content

fediverse_pasture_inputs.tool

python -mfediverse_pasture_inputs

Tool for helping with creating the documentation for the fediverse-pasture-inputs

Usage:

python -mfediverse_pasture_inputs [OPTIONS] COMMAND [ARGS]...

Options:

Name Type Description Default
--help boolean Show this message and exit. False

Subcommands

  • docs: Creates a documentation page for each input
  • navigation: Writes the .pages file for the inputs used to generate the documentation.
  • zip-file: Creates a zip file containing the the generated ActivityPub objects

python -mfediverse_pasture_inputs docs

Creates a documentation page for each input

Usage:

python -mfediverse_pasture_inputs docs [OPTIONS]

Options:

Name Type Description Default
--path text Path of the directory the documentation pages are to be deposited docs/inputs
--no_navigation boolean N/A False
--watch boolean Watch for changes in the fediverse_pasture_inputs directory False
--help boolean Show this message and exit. False

python -mfediverse_pasture_inputs navigation

Writes the .pages file for the inputs used to generate the documentation. Usually runs automatically when generating the documentation.

Usage:

python -mfediverse_pasture_inputs navigation [OPTIONS]

Options:

Name Type Description Default
--path text Path of the directory the documentation pages are to be deposited docs/inputs
--help boolean Show this message and exit. False

python -mfediverse_pasture_inputs zip-file

Creates a zip file containing the the generated ActivityPub objects and activities

Usage:

python -mfediverse_pasture_inputs zip-file [OPTIONS]

Options:

Name Type Description Default
--path text Path of the directory the zip file is created at docs/assets
--help boolean Show this message and exit. False

fediverse_pasture_inputs.tool

current_asset_archive 

current_asset_archive(
    tag: str = __version__,
) -> Generator[ZipFile, None, None]

Downloads the zipfile for tag and then provides it as a generator.

>>> with current_asset_archive("0.1.8") as assets:
...     assets.namelist()
    ['assets/', 'assets/note2.jsonap', ...]

Returns:

Type Description
Generator[ZipFile, None, None]

archive of the inputs
Source code in fediverse_pasture_inputs/tool/__init__.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@contextmanager
def current_asset_archive(
    tag: str = __version__,
) -> Generator[zipfile.ZipFile, None, None]:
    """
    Downloads the zipfile for `tag` and then
    provides it as a generator.

    ```pycon
    >>> with current_asset_archive("0.1.8") as assets:
    ...     assets.namelist()
        ['assets/', 'assets/note2.jsonap', ...]

    ```

    :returns: archive of the inputs
    """
    with tempfile.TemporaryDirectory() as tmpdirname:
        filename = f"{tmpdirname}/assets.zip"
        urlretrieve(make_url(tag), filename)
        with zipfile.ZipFile(filename) as fp:
            yield fp

extract 

extract(tag: str = __version__)

Extracts the asset zipfile

Source code in fediverse_pasture_inputs/tool/__init__.py 
47
48
49
50
def extract(tag: str = __version__):
    """Extracts the asset zipfile"""
    with current_asset_archive(tag) as archive:
        archive.extractall()

make_url 

make_url(tag)

Returns the url of the asset zip file

>>> make_url("0.1.8")
'https://codeberg.org/api/packages/funfedidev/generic/fediverse_pasture_assets/0.1.8/fediverse_pasture_assets.zip'
Source code in fediverse_pasture_inputs/tool/__init__.py 
11
12
13
14
15
16
17
18
19
20
def make_url(tag):
    """Returns the url of the asset zip file

    ```pycon
    >>> make_url("0.1.8")
    'https://codeberg.org/api/packages/funfedidev/generic/fediverse_pasture_assets/0.1.8/fediverse_pasture_assets.zip'

    ```
    """
    return f"https://codeberg.org/api/packages/funfedidev/generic/fediverse_pasture_assets/{tag}/fediverse_pasture_assets.zip"

transformer

Helper class to create object and activity from examples

ExampleTransformer

Class to create objects and activities from examples

Source code in fediverse_pasture_inputs/tool/transformer.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
class ExampleTransformer:
    """Class to create objects and activities from
    examples"""

    def __init__(self):
        self.sender = activity_sender()

    async def init_sender_for_example(self, example):
        self.sender.init_create_note(lambda x: {**x, **example})
        await self.sender.send("http://remote.example/")

    async def create_object(self, example):
        """Creates the sample object

        ```pycon
        >>> import asyncio
        >>> et = ExampleTransformer()
        >>> asyncio.run(et.create_object({"content": "moo"}))
        {'type': 'Note',
            'attributedTo': 'http://actor.example',
            'to': ['https://www.w3.org/ns/activitystreams#Public'],
            'id': 'http://actor.example/...',
            'published': '...',
            'content': 'moo',
            '@context': ['https://www.w3.org/ns/activitystreams',
                {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}]}

        ```
        """
        await self.init_sender_for_example(example)
        obj = self.sender.note

        if obj is None:
            raise Exception("Failed ot created note")

        if "@context" not in obj:
            obj["@context"] = [
                "https://www.w3.org/ns/activitystreams",
                {"Hashtag": "as:Hashtag", "sensitive": "as:sensitive"},
            ]
        return obj

    async def create_activity(self, example):
        """Creates the sample activity

        ```pycon
        >>> import asyncio
        >>> et = ExampleTransformer()
        >>> asyncio.run(et.create_activity({"content": "moo"}))
        {'@context': ['https://www.w3.org/ns/activitystreams',
            {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}],
            'type': 'Create',
            'actor': 'http://actor.example',
            'to': [...],
            'id': 'http://actor.example/...',
            'published': '...',
            'object': {'type': 'Note',
                'attributedTo': 'http://actor.example',
                'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://remote.example/'],
                'id': 'http://actor.example/...',
                'published': '...',
                'content': 'moo'}}

        ```
        """
        await self.init_sender_for_example(example)
        return self.sender.activity
create_activity async 
create_activity(example)

Creates the sample activity

>>> import asyncio
>>> et = ExampleTransformer()
>>> asyncio.run(et.create_activity({"content": "moo"}))
{'@context': ['https://www.w3.org/ns/activitystreams',
    {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}],
    'type': 'Create',
    'actor': 'http://actor.example',
    'to': [...],
    'id': 'http://actor.example/...',
    'published': '...',
    'object': {'type': 'Note',
        'attributedTo': 'http://actor.example',
        'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://remote.example/'],
        'id': 'http://actor.example/...',
        'published': '...',
        'content': 'moo'}}
Source code in fediverse_pasture_inputs/tool/transformer.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
async def create_activity(self, example):
    """Creates the sample activity

    ```pycon
    >>> import asyncio
    >>> et = ExampleTransformer()
    >>> asyncio.run(et.create_activity({"content": "moo"}))
    {'@context': ['https://www.w3.org/ns/activitystreams',
        {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}],
        'type': 'Create',
        'actor': 'http://actor.example',
        'to': [...],
        'id': 'http://actor.example/...',
        'published': '...',
        'object': {'type': 'Note',
            'attributedTo': 'http://actor.example',
            'to': ['https://www.w3.org/ns/activitystreams#Public', 'http://remote.example/'],
            'id': 'http://actor.example/...',
            'published': '...',
            'content': 'moo'}}

    ```
    """
    await self.init_sender_for_example(example)
    return self.sender.activity
create_object async 
create_object(example)

Creates the sample object

>>> import asyncio
>>> et = ExampleTransformer()
>>> asyncio.run(et.create_object({"content": "moo"}))
{'type': 'Note',
    'attributedTo': 'http://actor.example',
    'to': ['https://www.w3.org/ns/activitystreams#Public'],
    'id': 'http://actor.example/...',
    'published': '...',
    'content': 'moo',
    '@context': ['https://www.w3.org/ns/activitystreams',
        {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}]}
Source code in fediverse_pasture_inputs/tool/transformer.py 
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
async def create_object(self, example):
    """Creates the sample object

    ```pycon
    >>> import asyncio
    >>> et = ExampleTransformer()
    >>> asyncio.run(et.create_object({"content": "moo"}))
    {'type': 'Note',
        'attributedTo': 'http://actor.example',
        'to': ['https://www.w3.org/ns/activitystreams#Public'],
        'id': 'http://actor.example/...',
        'published': '...',
        'content': 'moo',
        '@context': ['https://www.w3.org/ns/activitystreams',
            {'Hashtag': 'as:Hashtag', 'sensitive': 'as:sensitive'}]}

    ```
    """
    await self.init_sender_for_example(example)
    obj = self.sender.note

    if obj is None:
        raise Exception("Failed ot created note")

    if "@context" not in obj:
        obj["@context"] = [
            "https://www.w3.org/ns/activitystreams",
            {"Hashtag": "as:Hashtag", "sensitive": "as:sensitive"},
        ]
    return obj