Skip to content

Commit

Permalink
Add LICENSES and update README (#537)
Browse files Browse the repository at this point in the history
* Fix up README & add LICENSE

* move our scripts

* Add license headers

* modify setup.py with license in classifiers

* Change license from TBD to MIT

* Use contoso.com instead of test.com for url used in test and modify preview instructions

* Add license header to new file recently added
  • Loading branch information
derekbekoe authored Jul 21, 2016
1 parent 83bbb74 commit 5173fd1
Show file tree
Hide file tree
Showing 145 changed files with 770 additions and 276 deletions.
21 changes: 0 additions & 21 deletions .hgeol

This file was deleted.

9 changes: 9 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Contribute Code
===================================

This project has adopted the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`__.

For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`__ or contact `[email protected] <mailto:[email protected]>`__ with any additional questions or comments.

If you would like to become an active contributor to this project please
follow the instructions provided in `Microsoft Azure Projects Contribution Guidelines <http://azure.github.io/guidelines.html>`__
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

FROM python:3.5

# Set the working directory
Expand Down
13 changes: 13 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Azure CLI

Copyright (c) Microsoft Corporation

All rights reserved.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 changes: 19 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
Microsoft Project AZ - Preview
==================================

.. image:: https://travis-ci.com/Azure/azure-cli.svg?branch=master
:target: https://travis-ci.com/Azure/azure-cli

==================================

A great cloud needs great tools; we're excited to introduce *Project Az*, our prototype for building a great, multiplatform commandline experience for Azure.

Project Az is built on Python (2.7, 3.4 and 3.5).
Expand All @@ -11,15 +16,15 @@ Installation
For installation steps for common platforms, please take a look at our `preview installation guide <http://github.com/Azure/azure-cli/blob/master/doc/preview_install_guide.md>`__.

Docker Setup (optional)
------------
-----------------------
We have automated Docker images of the latest code in the master branch.

If you have not previously done so, configure your Docker client engine [here](https://docs.docker.com/engine/installation/).
If you have not previously done so, `configure your Docker client engine <https://docs.docker.com/engine/installation/>`__.

Then:
+ Run `docker login` (contact the team for credentials as the images are not public yet).
+ Run `docker pull azuresdk/azure-cli-python:latest`
+ Run `docker run -it azuresdk/azure-cli-python:latest`
+ Run :code:`docker login` (contact the team for credentials as the images are not public yet).
+ Run :code:`docker pull azuresdk/azure-cli-python:latest`
+ Run :code:`docker run -it azuresdk/azure-cli-python:latest`

Usage
=====
Expand All @@ -31,7 +36,7 @@ Usage
For sample scripts and commands, please visit the `Demo Scripts <https://github.com/Azure/azure-cli/blob/master/doc/preview_demo_scripts.md>`__ page.

Download Source Code
--------------------
====================

To get the source code of the SDK via **git** type

Expand All @@ -51,7 +56,9 @@ To provide feedback from the command line, try the ``az feedback`` command.
Contribute Code
===================================

This project has adopted the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`__. For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`__ or contact `[email protected] <mailto:[email protected]>`__ with any additional questions or comments.
This project has adopted the `Microsoft Open Source Code of Conduct <https://opensource.microsoft.com/codeofconduct/>`__.

For more information see the `Code of Conduct FAQ <https://opensource.microsoft.com/codeofconduct/faq/>`__ or contact `[email protected] <mailto:[email protected]>`__ with any additional questions or comments.

If you would like to become an active contributor to this project please
follow the instructions provided in `Microsoft Azure Projects Contribution Guidelines <http://azure.github.io/guidelines.html>`__
Expand All @@ -60,3 +67,8 @@ Learn More
==========

`Microsoft Azure Python Developer Center <http://azure.microsoft.com/en-us/develop/python/>`__

License
=======

`MIT <https://github.com/Azure/azure-cli/blob/master/LICENSE.txt>`__
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
version='0.0.1',
description='Microsoft Azure Command-Line Tools Example Command Module',
long_description=README,
license='TBD',
license='MIT',
author='Example Author',
author_email='[email protected]',
url='https://github.com/example/repo',
Expand Down
4 changes: 2 additions & 2 deletions doc/preview_instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Installation via CURL

To install via cURL on Linux, Unix and OS X, type:

curl http://azure-cli-nightly.westus.cloudapp.azure.com/install | bash
curl -L https://aka.ms/ProjectAzInstall | bash

If you chose to enable tab completion, type `exec -l $SHELL` to restart your shell.

Note: This will install the latest nightly builds. You may re-run this script later to safely update to the latest version.
Note: This will install the latest verified nightly builds. You may re-run this script later to safely update to the latest version.

Example Demo Script
-------------------
Expand Down
5 changes: 5 additions & 0 deletions doc/sphinx/azhelpgen/azhelpgen.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

import argparse
from docutils import nodes
from docutils.statemachine import ViewList
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_coverage.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function
import os
import sys
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_modules/_common.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function
import os
import sys
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_modules/install.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

## Install the command modules using pip ##
from __future__ import print_function
import os
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_modules/package_verify.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

## Install the command modules using pip ##
from __future__ import print_function
import os
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_modules/pylint.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

## Runs pylint on the command modules ##
from __future__ import print_function
import os
Expand Down
5 changes: 5 additions & 0 deletions scripts/command_modules/test.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

## Run the tests for each command module ##

from __future__ import print_function
Expand Down
6 changes: 6 additions & 0 deletions scripts/dev_setup.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/usr/bin/python

#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function
import sys
from subprocess import check_call, CalledProcessError
Expand Down
5 changes: 5 additions & 0 deletions scripts/dump_command_table.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function

import argparse
Expand Down
5 changes: 5 additions & 0 deletions scripts/generate_command_inventory.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

import argparse
import json
import re
Expand Down
6 changes: 6 additions & 0 deletions scripts/install/install
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/usr/bin/env bash

#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

#
# Bash script to install the Azure CLI
#
Expand Down
6 changes: 6 additions & 0 deletions scripts/install/install.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/usr/bin/env python

#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

#
# This script will install the CLI into a directory and create an executable
# at a specified file path that is the entry point into the CLI.
Expand Down
6 changes: 6 additions & 0 deletions scripts/install/setup_completion.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
#!/usr/bin/env python

#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

#
# This script will set up tab completion for the Azure CLI.
#
Expand Down
File renamed without changes.
File renamed without changes.
7 changes: 6 additions & 1 deletion scripts/sdk_command_gen/gen_command_module.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

"""
Generate a command module using the SDK.
"""
Expand Down Expand Up @@ -79,7 +84,7 @@
version=VERSION,
description='Microsoft Azure Command-Line Tools',
long_description=README,
license='TBD',
license='MIT',
author='Microsoft Corporation',
author_email='[email protected]',
url='https://github.com/Azure/azure-cli',
Expand Down
5 changes: 5 additions & 0 deletions scripts/sdk_command_gen/gen_generated_file.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

"""
Create the generated.py file for a command module.
"""
Expand Down
5 changes: 5 additions & 0 deletions scripts/smart_create_gen/_common.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

import configparser
import os
import re
Expand Down
5 changes: 5 additions & 0 deletions scripts/smart_create_gen/generate_smart_create.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function

import distutils
Expand Down
5 changes: 5 additions & 0 deletions scripts/smart_create_gen/template_to_swagger.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function

from collections import OrderedDict
Expand Down
5 changes: 5 additions & 0 deletions scripts/smart_create_gen/upload_arm_templates.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function

import json
Expand Down
5 changes: 5 additions & 0 deletions scripts/smoke_test_install/_common.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

import os
import sys
from six import StringIO, text_type, u
Expand Down
5 changes: 5 additions & 0 deletions scripts/smoke_test_install/test_install_linux.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from _common import (create_vm,
install_cli_interactive,
verify_basic,
Expand Down
File renamed without changes.
File renamed without changes.
25 changes: 6 additions & 19 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
#!/usr/bin/env python

#-------------------------------------------------------------------------
# Copyright (c) Microsoft. All rights reserved.
#
# 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.
#--------------------------------------------------------------------------
#---------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
#---------------------------------------------------------------------------------------------

from __future__ import print_function
import os
Expand Down Expand Up @@ -48,8 +38,6 @@
print('Expected __version__ = "{}"; found "{}"'.format(VERSION, m.group(1)))
sys.exit(1)

# The full list of classifiers is available at
# https://pypi.python.org/pypi?%3Aaction=list_classifiers
CLASSIFIERS = [
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
Expand All @@ -60,8 +48,7 @@
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.4',
'Programming Language :: Python :: 3.5',
#'License :: OSI Approved :: Apache Software License',
#'License :: OSI Approved :: MIT License',
'License :: OSI Approved :: MIT License',
]

DEPENDENCIES = [
Expand Down Expand Up @@ -114,7 +101,7 @@ def run(self):
version=VERSION,
description='Microsoft Azure Command-Line Tools',
long_description=README,
license='TBD',
license='MIT',
author='Microsoft Corporation',
author_email='[email protected]',
url='https://github.com/Azure/azure-cli',
Expand Down
Loading

0 comments on commit 5173fd1

Please sign in to comment.