From 78045e9842a1393a01487968264b23b22d72037e Mon Sep 17 00:00:00 2001
From: Adar Nimrod <nimrod@shore.co.il>
Date: Tue, 8 Mar 2016 11:32:16 +0200
Subject: [PATCH] - Added Vagrantfile. - Imporoved docmentation for
development.
---
.gitignore | 6 ++++--
MANIFEST.in | 2 +-
README.rst | 24 ++++++++++++++++++++++--
Vagrantfile | 18 ++++++++++++++++++
4 files changed, 45 insertions(+), 5 deletions(-)
create mode 100644 Vagrantfile
diff --git a/.gitignore b/.gitignore
index 53bd95c..9c22d00 100644
--- a/.gitignore
+++ b/.gitignore
@@ -9,5 +9,7 @@ dist/
*.egg-info/
__pycache__/
*.log
-.tox
-.cache
+.tox/
+.cache/
+.vagrant/
+.idea/
diff --git a/MANIFEST.in b/MANIFEST.in
index 9620571..739eaea 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1,2 +1,2 @@
recursive-include unshare
-exclude .pre-commit-config.yaml Makefile
+exclude .pre-commit-config.yaml Makefile Vagrantfile
diff --git a/README.rst b/README.rst
index 6d60ec5..f29ecf5 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,25 @@
python-unshare
##############
-This is a pure-Python module for accessing libc functions and macros needed
-for dealing with Linux namespaces.
+This is a pure-Python module with no external dependecies for accessing libc
+functions and macros needed for dealing with Linux namespaces.
+
+Development
+-----------
+
+Development has the following dependecies:
+- Tox (install from PyPI by running (:code:`pip install tox`).
+- libc headers, make and GCC (On Debian/Ubuntu install by running :code:`apt
+install linux-libc-dev build-essential`).
+
+Testing is done by running :code:`tox`. Auto-generated code (for now just
+:code:`unshare/constants.py`) is generated by running :code:`make all`. For Mac
+developers there's a Vagrant box defined (it optionally uses
+`vagrant-gatling-rsync <https://github.com/smerrill/vagrant-gatling-rsync>`_).
+
+TODO
+----
+
+- License.
+- Changelog.
+- Documentation.
diff --git a/Vagrantfile b/Vagrantfile
new file mode 100644
index 0000000..d442cea
--- /dev/null
+++ b/Vagrantfile
@@ -0,0 +1,18 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+Vagrant.configure(2) do |config|
+ config.vm.box = "debian/jessie64"
+ if Vagrant.has_plugin?("vagrant-gatling-rsync")
+ config.gatling.latency = 2.5
+ config.gatling.time_format = "%H:%M:%S"
+ config.gatling.rsync_on_startup = true
+ end
+ config.vm.synced_folder ".", "/home/vagrant/python-unshare",
+ type: "rsync",
+ rsync__exclude: [".cache", ".tox", "*.egg-info", "*.swp", ".DS_Store", ".idea"]
+ config.vm.provision "shell", inline: <<-SHELL
+ sudo apt-get update
+ sudo apt-get install -yf build-essential linux-libc-dev python-pip python3-pip git
+ sudo pip install tox
+ SHELL
+end
--
GitLab