init

create_changelog()

Create the changelog file.

Returns:

Type	Description
Res[str | None]	A OneOf containing 0 if successful or an Issue.

Source code in m/ci/init.py

def create_changelog() -> Res[str | None]:
    """Create the changelog file.

    Returns:
        A `OneOf` containing 0 if successful or an `Issue`.
    """
    body = """\
        # Changelog

        The format of this changelog is based on
        [Keep a Changelog](http://keepachangelog.com/en/1.0.0/). The project adheres to
        [Semantic Versioning](http://semver.org/spec/v2.0.0.html)

        > Major version zero (0.y.z) is for initial development. Anything may change at
        > any time. The public API should not be considered stable.

        ## [Unreleased]
    """
    file_name = 'CHANGELOG.md'
    if Path.exists(Path(file_name)):
        logger.warning(f'{file_name} already exists')
        return Good(None)
    return one_of(lambda: [
        file_name
        for _ in mio.write_file('CHANGELOG.md', dedent(body))
        for _ in logger.info(f'created {file_name}')
    ])

create_m_config()

Create the m configuration file.

Returns:

Type	Description
Res[str | None]	The name of the m file or none if successful. Otherwise an Issue.

Source code in m/ci/init.py

def create_m_config() -> Res[str | None]:
    """Create the m configuration file.

    Returns:
        The name of the m file or none if successful. Otherwise an `Issue`.
    """
    file_name = 'm/m.yaml'
    if Path.exists(Path(file_name)):
        logger.warning(f'{file_name} already exists')
        return Good(None)
    m_dir = Path('m')
    if not Path.exists(m_dir):
        Path.mkdir(m_dir, parents=True)
    return one_of(lambda: [
        file_name
        for owner, repo in get_repo_info()
        for _ in mio.write_file(file_name, m_config_body(owner, repo))
        for _ in logger.info(f'created {file_name}', {
            'owner': owner,
            'repo': repo,
        })
    ])

get_repo_info()

Get the owner and repo name from the current repository.

Returns:

Type	Description
Res[Tuple[str, str]]	A tuple with the owner and repo (or an Issue).

Source code in m/ci/init.py

def get_repo_info() -> Res[Tuple[str, str]]:
    """Get the owner and repo name from the current repository.

    Returns:
        A tuple with the owner and repo (or an Issue).
    """
    return one_of(lambda: [
        owner_repo
        for ssh_url in get_remote_url()
        for owner_repo in parse_ssh_url(ssh_url)
    ])

init_repo()

Initialize a repository with the basic project configurations.

Returns:

Type	Description
Res[None]	A OneOf containing 0 if successful or an Issue.

Source code in m/ci/init.py

def init_repo() -> Res[None]:
    """Initialize a repository with the basic project configurations.

    Returns:
        A `OneOf` containing 0 if successful or an `Issue`.
    """
    return one_of(lambda: [
        None
        for m_file in create_m_config()
        for gitignore in update_gitignore()
        for changelog in create_changelog()
        for _ in logger.info('setup complete', {
            'modified_files': [x for x in (m_file, gitignore, changelog) if x],
        })
    ])

m_config_body(owner, repo)

Create the basic contents of a m configuration file.

Parameters:

Name	Type	Description	Default
owner	str	The repo owner.	required
repo	str	The repo name.	required

Returns:

Type	Description
str	A yaml string to be the content of the m.yaml file.

Source code in m/ci/init.py

def m_config_body(owner: str, repo: str) -> str:
    """Create the basic contents of a m configuration file.

    Args:
        owner: The repo owner.
        repo: The repo name.

    Returns:
        A yaml string to be the content of the `m.yaml` file.
    """
    body = f"""\
        owner: {owner}
        repo: {repo}
        version: 0.0.0
        workflow: m_flow
    """
    return dedent(body)

parse_ssh_url(ssh_url)

Find the owner and repo from an ssh url.

Parameters:

Name	Type	Description	Default
ssh_url	str	The url of the repo	required

Returns:

Type	Description
Res[Tuple[str, str]]	A tuple with the owner and repo (or an Issue).

Source code in m/ci/init.py

def parse_ssh_url(ssh_url: str) -> Res[Tuple[str, str]]:
    """Find the owner and repo from an ssh url.

    Args:
        ssh_url: The url of the repo

    Returns:
        A tuple with the owner and repo (or an Issue).
    """
    match = re.findall('.*:(.*)/(.*).git', ssh_url)
    if match and match[0] and match[0][0] and match[0][1]:
        return Good(match[0])
    return issue(
        'unable to obtain owner and repo',
        context={'ssh_url': ssh_url},
    )

update_gitignore()

Update the gitignore file.

Adds the m/.m directory to the list.

Returns:

Type	Description
Res[str | None]	A OneOf containing file name or an Issue if it was unable to update
Res[str | None]	the file.

Source code in m/ci/init.py

def update_gitignore() -> Res[str | None]:
    """Update the gitignore file.

    Adds the m/.m directory to the list.

    Returns:
        A `OneOf` containing file name or an Issue if it was unable to update
        the file.
    """
    file_name = '.gitignore'
    return one_of(lambda: [
        fname
        for _ in subprocess.eval_cmd(f'touch {file_name}')
        for body in mio.read_file(file_name)
        for fname in _update_gitignore(file_name, body)
    ])