Skip to content

Commit

Permalink
Merge pull request #27 from pnemade/devel
Browse files Browse the repository at this point in the history
Prepare for 0.5.0 release
  • Loading branch information
pnemade authored Jul 13, 2021
2 parents da78f74 + 10dc678 commit 23d74e0
Show file tree
Hide file tree
Showing 7 changed files with 33 additions and 24 deletions.
7 changes: 7 additions & 0 deletions Changlog.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
Changelog
=========

0.5.0 (2020-07-12)
-----------------
- Update textoutput.py (sundeep-co-in)
- Add new options repo-type and repo-branch to job run command (sundeep-co-in)
- Update man page (pnemade)
- Change Problematic language in code (pnemade)

0.4.0 (2020-07-09)
-----------------
- Dropping flake8 dependency (pnemade)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Commands:
* Fork [transtats-cli repo](https://github.com/transtats/transtats-cli) to your username and clone repository locally.
* Setup development environment `pip install -r requirements.txt`
* The *devel* branch is the release actively under development.
* The *master* branch corresponds to the latest stable release.
* The *main* branch corresponds to the latest stable release.
* If you find any bug/issue or got an idea, open a [github issue](https://github.com/transtats/transtats-cli/issues/new).
* [travis](https://travis-ci.org/transtats/transtats-cli) runs flake8 and tests `python setup.py flake8 test`
* Feel free to submit feature requests and/or bug fixes on *devel* branch.
Expand Down
38 changes: 20 additions & 18 deletions docs/man/transtats.1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.\" transtats - Command line interface for transtats
.TH "TRANSTATS" "1" "9th June 2020" "transtats 0.4.0" "User Commands"
.TH "TRANSTATS" "1" "12th July 2021" "transtats 0.5.0" "User Commands"
.SH "NAME"
transtats \- Command line interface for transtats
.SH "SYNOPSIS"
Expand All @@ -16,6 +16,19 @@ Show this message and exit.
.I \fB * coverage [OPTIONS] GRAPH_RULE
Translation coverage as per graph rule.

.br
.I \fB * job [OPTIONS] COMMAND [ARGS]....
Job related operations. There are two sub-commands used with this job command.

1) transtats job log [OPTIONS] JOB_ID
Show the log for a given job id.

2) transtats job run [OPTIONS] REPO_TYPE REPO_BRANCH JOB_TYPE PACKAGE_NAME
Runs a job and/or show the job log.
Available job-types are syncupstream, syncdownstream, stringchange,
pushtrans, dpushtrans, pulltrans
Available repo-types are default, l10n, transifex, weblate

.br
.I \fB * package [OPTIONS] PACKAGE_NAME
Translation status of a package.
Expand All @@ -28,16 +41,6 @@ Show this message and exit.
.I \fB * release [OPTIONS] RELEASE_SLUG
Translation status of a release slug(branch).

.br
.I \fB * job [OPTIONS] COMMAND [ARGS]....
Job related operations. There are two sub-commands used with this job command.

1) transtats job log [OPTIONS] JOB_ID
Show the log for a given job id.

2) transtats job run [OPTIONS] JOB_TYPE PACKAGE_NAME
Runs a job and/or show the job log. Available job-types are syncupstream, syncdownstream, stringchange.

.SH "EXAMPLES"
.PP
\fBTo check the translation coverage as per predefined graph rule on transtats server.\fP
Expand All @@ -57,12 +60,12 @@ Show this message and exit.

.PP
\fBTo check the translation status for available packages in any pre-defined Linux distribution release on transtats server.\fP
transtats release fedora-33
transtats release fedora-35

.PP
\fBTo check the translation status for available packages in any pre-defined Linux distribution release on transtats server.\fP
\fBBut if you need to know this status categorized by individual languages then use --detail\fP
transtats release --detail fedora-33
transtats release --detail fedora-35

.PP
\fBTo know the version of this transtats client.\fP
Expand All @@ -73,12 +76,11 @@ Show this message and exit.
transtats version --server

.PP
\fBTo submit a job to transtats server. There are 3 types of job that users can submit.\fP
These job types are syncupstream, syncdownstream, stringchange.
\fBTo submit a job to transtats server. There are 6 types of job that users can submit.\fP
Various job type command examples are given below
transtats job run stringchange anaconda
transtats job run syncdownstream anaconda --build-system koji --build-tag f33
transtats job run stringchange anaconda --release-slug fedora-33
transtats job run --repo-type l10n --repo-branch f35 syncupstream anaconda
transtats job run --repo-type l10n --repo-branch f35 --build-system koji --build-tag f35 syncdownstream anaconda
transtats job run --repo-branch main --release-slug fedora-33 stringchange anaconda

.SH "NOTES"
These commands give output in plain text format. If you need the same output
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@
'Intended Audience :: Developers',
'Programming Language :: Python',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Programming Language :: Python :: 3.10',
],
)
2 changes: 1 addition & 1 deletion tests/test_tscli.py
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ def test_job_run_upstream(self):
runner = CliRunner()
result = runner.invoke(entry_point,
['job', 'run', '--repo-type', 'l10n',
'--repo-branch', 'master', 'syncupstream', 'iok'])
'--repo-branch', 'main', 'syncupstream', 'iok'])
self.assertEqual(result.exit_code, 0)
self.assertIn('Success', result.output)
self.assertIn('Job_Id', result.output)
Expand Down
4 changes: 2 additions & 2 deletions tscli/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright 2017-2020 Red Hat, Inc.
# Copyright 2017-2021 Red Hat, Inc.
# All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
Expand All @@ -21,7 +21,7 @@
from tscli.stats import commands as trans
from tscli.jobs import commands as jobs

APP_VERSION = "0.4.0"
APP_VERSION = "0.5.0"


class AppContext(object):
Expand Down
2 changes: 1 addition & 1 deletion tscli/jobs/commands.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def job():
@click.option("--repo-type", is_flag=False,
help="repo type like default or l10n")
@click.option("--repo-branch", is_flag=False,
help="repository branch like master")
help="repository branch like main")
@click.option(
'--json', is_flag=True, envvar='JSON_OUTPUT', help="Print in JSON format")
@click.argument('job_type')
Expand Down

0 comments on commit 23d74e0

Please sign in to comment.