Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move static metadata to declarative setup.cfg #38413

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
prune ticket_stubs
prune hacking
include README.md COPYING
include README.rst COPYING
include SYMLINK_CACHE.json
include requirements.txt
include .coveragerc
Expand Down
56 changes: 0 additions & 56 deletions README.md

This file was deleted.

104 changes: 104 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
|PyPI version| |Build Status|

*******
Ansible
*******

Ansible is a radically simple IT automation system. It handles
configuration-management, application deployment, cloud provisioning,
ad-hoc task-execution, and multinode orchestration -- including
trivializing things like zero-downtime rolling updates with load
balancers.

Read the documentation and more at https://ansible.com/

You can find installation instructions
`here <https://docs.ansible.com/intro_getting_started.html>`_ for a
variety of platforms.

Most users should probably install a released version of Ansible from ``pip``, a package manager or
our `release repository <https://releases.ansible.com/ansible/>`_. `Officially supported
<https://www.ansible.com/ansible-engine>`_ builds of Ansible are also available. Some power users
run directly from the development branch - while significant efforts are made to ensure that
``devel`` is reasonably stable, you're more likely to encounter breaking changes when running
Ansible this way.

If you want to download a tarball of a release, go to
`releases.ansible.com <https://releases.ansible.com/ansible>`_, though
most users use ``yum`` (using the EPEL instructions linked above),
``apt`` (using the PPA instructions linked above), or
``pip install ansible``.

Design Principles
=================

* Have a dead simple setup process and a minimal learning curve
* Manage machines very quickly and in parallel
* Avoid custom-agents and additional open ports, be agentless by
leveraging the existing SSH daemon
* Describe infrastructure in a language that is both machine and human
friendly
* Focus on security and easy auditability/review/rewriting of content
* Manage new remote machines instantly, without bootstrapping any
software
* Allow module development in any dynamic language, not just Python
* Be usable as non-root
* Be the easiest IT automation system to use, ever.

Get Involved
============

* Read `Community
Information <https://docs.ansible.com/community.html>`_ for all
kinds of ways to contribute to and interact with the project,
including mailing list information and how to submit bug reports and
code to Ansible.
* All code submissions are done through pull requests. Take care to
make sure no merge commits are in the submission, and use
``git rebase`` vs ``git merge`` for this reason. If submitting a
large code change (other than modules), it's probably a good idea to
join ansible-devel and talk about what you would like to do or add
first and to avoid duplicate efforts. This not only helps everyone
know what's going on, it also helps save time and effort if we decide
some changes are needed.
* Users list:
`ansible-project <https://groups.google.com/group/ansible-project>`_
* Development list:
`ansible-devel <https://groups.google.com/group/ansible-devel>`_
* Announcement list:
`ansible-announce <https://groups.google.com/group/ansible-announce>`_
-- read only
* irc.freenode.net: #ansible

Branch Info
===========

* Releases are named after Led Zeppelin songs. (Releases prior to 2.0
were named after Van Halen songs.)
* The devel branch corresponds to the release actively under
development.
* Various release-X.Y branches exist for previous releases.
* We'd love to have your contributions, read `Community
Information <https://docs.ansible.com/community.html>`_ for notes on
how to get started.

Authors
=======

Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
(michael.dehaan/gmail/com) and has contributions from over 1000 users
(and growing). Thanks everyone!

Ansible is sponsored by `Ansible, Inc <https://ansible.com>`_

Licence
=======

GNU General Public License v3.0

See `COPYING <COPYING>`_ to see the full text.

.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg
:target: https://pypi.python.org/pypi/ansible
.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
:target: https://app.shippable.com/projects/573f79d02a8192902e20e34b
2 changes: 1 addition & 1 deletion packaging/arch/PKGBUILD
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ package() {

install -Dm644 examples/ansible.cfg $pkgdir/etc/ansible/ansible.cfg

install -Dm644 README.md $pkgdir/usr/share/doc/ansible/README.md
install -Dm644 README.rst $pkgdir/usr/share/doc/ansible/README.rst
install -Dm644 COPYING $pkgdir/usr/share/doc/ansible/COPYING
install -Dm644 CHANGELOG.md $pkgdir/usr/share/doc/ansible/CHANGELOG.md

Expand Down
2 changes: 1 addition & 1 deletion packaging/macports/sysutils/ansible/Portfile
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ patch {

post-destroot {
# documentation and examples
xinstall -m 644 -W ${worksrcpath} README.md CHANGELOG.md CONTRIBUTING.md COPYING \
xinstall -m 644 -W ${worksrcpath} README.rst CHANGELOG.md CONTRIBUTING.md COPYING \
${destroot}${prefix}/share/doc/${name}

xinstall -m 755 -d ${destroot}${prefix}/share/doc/examples
Expand Down
2 changes: 1 addition & 1 deletion packaging/rpm/ansible.spec
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ rm -rf %{buildroot}
%{_bindir}/ansible*
%dir %{_datadir}/ansible
%config(noreplace) %{_sysconfdir}/ansible
%doc README.md PKG-INFO COPYING CHANGELOG.md
%doc README.rst PKG-INFO COPYING CHANGELOG.md
%doc %{_mandir}/man1/ansible*

%changelog
Expand Down
66 changes: 66 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
[metadata]
name = ansible
url = https://ansible.com/
description = Radically simple IT automation
long_description = file: README.rst
author = Ansible, Inc.
author_email = [email protected]
license = GPLv3+
classifiers =
Development Status :: 5 - Production/Stable
Environment :: Console
Intended Audience :: Developers
Intended Audience :: Information Technology
Intended Audience :: System Administrators
License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Natural Language :: English
Operating System :: POSIX
Programming Language :: Python :: 2.6
Programming Language :: Python :: 2.7
Programming Language :: Python :: 3.5
Programming Language :: Python :: 3.6
Programming Language :: Python :: 3.7
Topic :: System :: Installation/Setup
Topic :: System :: Systems Administration
Topic :: Utilities
keywords =
ansible
automation
infrastructure

[options]
python_requires = >=2.6,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*
# Installing as zip files would break due to references to __file__
zip_safe = False
package_dir =
= lib
packages = find:
scripts =
bin/ansible
bin/ansible-playbook
bin/ansible-pull
bin/ansible-doc
bin/ansible-galaxy
bin/ansible-console
bin/ansible-connection
bin/ansible-vault
bin/ansible-config
bin/ansible-inventory

[options.package_data]
* =
module_utils/powershell/*.psm1
module_utils/powershell/*/*.psm1
modules/windows/*.ps1
modules/windows/*/*.ps1
galaxy/data/*/*.*
galaxy/data/*/*/.*
galaxy/data/*/*/*.*
galaxy/data/*/tests/inventory
config/base.yml

[options.packages.find]
where = lib

[bdist_wheel]
universal = 1
Loading