Git Product home page Git Product logo

daily_checks_cli's Introduction

Daily Checks CLI

Overview

The daily checks CLI allows users to upload daily checks/reports to Flight Center using the command line.

Usage

Installation

The following steps will install the daily checks CLI from git:

git clone https://github.com/alces-flight/daily_checks_cli.git
cd daily_checks_cli
bundle install

Operation

File storage and format

Files should be stored as pdfs in the /report folder, in the following format:

dd_mm_yy <cluster> report.pdf

where the date is the current date, and is the name of the cluster for which the report was created.

YAML file

A YAML file named components.yaml will need to be created and populated in order for the tool to grab the required details from a given shortcode. The YAML file should be written as follows:

<shortcode>:
    name: "<cluster>"
    auth: "<auth_token>"

with the fields filled in appropriately. Every cluster must be listed in this YAML file.

Running the tool

The following command will upload a report matching today's date and the cluster specified by the shortcode given from the /reports folder, assuming such a report is present:

ruby upload_reports.rb upload_report <shortcode>

Contributing

Fork the project. Make your feature addition or bug fix. Send a pull request. Bonus points for topic branches.

Read CONTRIBUTING.md for more details.

Copyright and License

Creative Commons Attribution-ShareAlike 4.0 License, see LICENSE.txt for details.

Copyright (C) 2019-present Alces Flight Ltd.

You should have received a copy of the license along with this work. If not, see http://creativecommons.org/licenses/by-sa/4.0/.

Creative Commons License

Daily checks CLI is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Based on a work at https://github.com/openflighthpc/daily_checks_cli.

This content and the accompanying materials are made available available under the terms of the Creative Commons Attribution-ShareAlike 4.0 International License which is available at https://creativecommons.org/licenses/by-sa/4.0/, or alternative license terms made available by Alces Flight Ltd - please direct inquiries about licensing to [email protected].

Daily checks CLI is distributed in the hope that it will be useful, but 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. See the Creative Commons Attribution-ShareAlike 4.0 International License for more details.

daily_checks_cli's People

Contributors

smackenzie23 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.