diff --git a/.github/workflows/setup.yml b/.github/workflows/setup.yml deleted file mode 100644 index de2a8fc..0000000 --- a/.github/workflows/setup.yml +++ /dev/null @@ -1,71 +0,0 @@ -name: Execute template to populate repository - -on: - push: - workflow_dispatch: - -jobs: - setup-repo: - if: ${{ github.repository != 'simonw/click-app-template-repository' }} - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - ref: ${{ github.head_ref }} - - - name: Install cookiecutter - run: pip3 install cookiecutter - - - uses: actions/github-script@v4 - id: fetch-repo-and-user-details - with: - script: | - const query = `query($owner:String!, $name:String!) { - repository(owner:$owner, name:$name) { - name - description - owner { - login - ... on User { - name - } - ... on Organization { - name - } - } - } - }`; - const variables = { - owner: context.repo.owner, - name: context.repo.repo - } - const result = await github.graphql(query, variables) - console.log(result) - return result - - - name: Rebuild contents using cookiecutter - env: - INFO: ${{ steps.fetch-repo-and-user-details.outputs.result }} - run: | - export REPO_NAME=$(echo $INFO | jq -r '.repository.name') - # Run cookiecutter - pushd /tmp - cookiecutter gh:simonw/click-app --no-input \ - app_name=$REPO_NAME \ - description="$(echo $INFO | jq -r .repository.description)" \ - github_username="$(echo $INFO | jq -r .repository.owner.login)" \ - author_name="$(echo $INFO | jq -r .repository.owner.name)" - popd - # Move generated content to root directory of repo - mv /tmp/$REPO_NAME/* . - # And .gitignore too: - mv /tmp/$REPO_NAME/.gitignore . - # Delete the setup.yml workflow, it has served its purpose - rm .github/workflows/setup.yml - - - name: Force push new repo contents - uses: stefanzweifel/git-auto-commit-action@v4 - with: - commit_message: "Initial library structure" - push_options: --force diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..53605b7 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.venv +__pycache__/ +*.py[cod] +*$py.class +venv +.eggs +.pytest_cache +*.egg-info +.DS_Store diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 2ea7aef..6663a01 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,40 @@ -# Template repository for creating new Python Click CLI tools +# dclient -This GitHub [template repository](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-repository-from-a-template) can be used to create a new repository with the skeleton of a Python [Click](https://click.palletsprojects.com/) CLI tool, based on the [click-app](https://github.com/simonw/click-app) cookiecutter. +[![PyPI](https://img.shields.io/pypi/v/dclient.svg)](https://pypi.org/project/dclient/) +[![Changelog](https://img.shields.io/github/v/release/simonw/dclient?include_prereleases&label=changelog)](https://github.com/simonw/dclient/releases) +[![Tests](https://github.com/simonw/dclient/workflows/Test/badge.svg)](https://github.com/simonw/dclient/actions?query=workflow%3ATest) +[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/dclient/blob/master/LICENSE) -Start here: https://github.com/simonw/click-app-template-repository/generate +A client CLI utility for Datasette instances -The name of your repository will be the name of the CLI tool, and also the name of the Python package that you publish to [PyPI](https://pypi.org/) - so make sure that name is not taken already! +## Installation -Add a one-line description of your CLI tool, then click "Create repository from template". +Install this tool using `pip`: -![Screenshot of the create repository interface](https://user-images.githubusercontent.com/9599/131272183-d2f1bb50-1ca1-42f2-936d-f23a6cbdbe13.png) + pip install dclient -Once created, your new repository will execute a GitHub Actions workflow that uses cookiecutter to rewrite the repository to the desired state. This make take 30 seconds or so. +## Usage -You can see an example of a repository generated using this template here: +For help, run: -- https://github.com/simonw/click-app-template-repository-demo + dclient --help -## GitHub Actions setup by this repository +You can also use: -The `test.yml` GitHub Actions workflow will run your tests automatically any time you push a change to the repo. + python -m dclient --help -The `publish.yml` Action runs when you create a new GitHub release. It can build and upload your package to [PyPI](https://pypi.org/). +## Development -For this to work, you need to create an API token for your PyPI account and add that to your repository as a secret called `PYPI_TOKEN`. +To contribute to this tool, first checkout the code. Then create a new virtual environment: -See [Publishing your library as a package to PyPI](https://github.com/simonw/click-app#publishing-your-library-as-a-package-to-pypi) for details. \ No newline at end of file + cd dclient + python -m venv venv + source venv/bin/activate + +Now install the dependencies and test dependencies: + + pip install -e '.[test]' + +To run the tests: + + pytest diff --git a/dclient/__init__.py b/dclient/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/dclient/__main__.py b/dclient/__main__.py new file mode 100644 index 0000000..98dcca0 --- /dev/null +++ b/dclient/__main__.py @@ -0,0 +1,4 @@ +from .cli import cli + +if __name__ == "__main__": + cli() diff --git a/dclient/cli.py b/dclient/cli.py new file mode 100644 index 0000000..99b00f4 --- /dev/null +++ b/dclient/cli.py @@ -0,0 +1,21 @@ +import click + + +@click.group() +@click.version_option() +def cli(): + "A client CLI utility for Datasette instances" + + +@cli.command(name="command") +@click.argument( + "example" +) +@click.option( + "-o", + "--option", + help="An example option", +) +def first_command(example, option): + "Command description goes here" + click.echo("Here is some output") diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..ede667e --- /dev/null +++ b/setup.py @@ -0,0 +1,39 @@ +from setuptools import setup +import os + +VERSION = "0.1" + + +def get_long_description(): + with open( + os.path.join(os.path.dirname(os.path.abspath(__file__)), "README.md"), + encoding="utf8", + ) as fp: + return fp.read() + + +setup( + name="dclient", + description="A client CLI utility for Datasette instances", + long_description=get_long_description(), + long_description_content_type="text/markdown", + author="Simon Willison", + url="https://github.com/simonw/dclient", + project_urls={ + "Issues": "https://github.com/simonw/dclient/issues", + "CI": "https://github.com/simonw/dclient/actions", + "Changelog": "https://github.com/simonw/dclient/releases", + }, + license="Apache License, Version 2.0", + version=VERSION, + packages=["dclient"], + entry_points=""" + [console_scripts] + dclient=dclient.cli:cli + """, + install_requires=["click"], + extras_require={ + "test": ["pytest"] + }, + python_requires=">=3.7", +) diff --git a/tests/test_dclient.py b/tests/test_dclient.py new file mode 100644 index 0000000..5b0dc2c --- /dev/null +++ b/tests/test_dclient.py @@ -0,0 +1,10 @@ +from click.testing import CliRunner +from dclient.cli import cli + + +def test_version(): + runner = CliRunner() + with runner.isolated_filesystem(): + result = runner.invoke(cli, ["--version"]) + assert result.exit_code == 0 + assert result.output.startswith("cli, version ")