Skip to content

Commit

Permalink
Changed name from schdl to skidl.
Browse files Browse the repository at this point in the history
  • Loading branch information
Dave Vandenbout committed Jul 23, 2016
1 parent c7c0aa7 commit 40b9add
Show file tree
Hide file tree
Showing 18 changed files with 217 additions and 196 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.rst
Expand Up @@ -13,7 +13,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/xesscorp/schdl/issues.
Report bugs at https://github.com/xesscorp/skidl/issues.

If you are reporting a bug, please include:

Expand All @@ -36,14 +36,14 @@ is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

schdl could always use more documentation, whether as part of the
official schdl docs, in docstrings, or even on the web in blog posts,
skidl could always use more documentation, whether as part of the
official skidl docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/xesscorp/schdl/issues.
The best way to send feedback is to file an issue at https://github.com/xesscorp/skidl/issues.

If you are proposing a feature:

Expand All @@ -55,17 +55,17 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `schdl` for local development.
Ready to contribute? Here's how to set up `skidl` for local development.

1. Fork the `schdl` repo on GitHub.
1. Fork the `skidl` repo on GitHub.
2. Clone your fork locally::

$ git clone git@github.com:your_name_here/schdl.git
$ git clone git@github.com:your_name_here/skidl.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv schdl
$ cd schdl/
$ mkvirtualenv skidl
$ cd skidl/
$ python setup.py develop

4. Create a branch for local development::
Expand All @@ -76,7 +76,7 @@ Ready to contribute? Here's how to set up `schdl` for local development.

5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::

$ flake8 schdl tests
$ flake8 skidl tests
$ python setup.py test
$ tox

Expand All @@ -100,12 +100,12 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check
https://travis-ci.org/xesscorp/schdl/pull_requests
https://travis-ci.org/xesscorp/skidl/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ python -m unittest tests.test_schdl
$ python -m unittest tests.test_skidl
2 changes: 1 addition & 1 deletion HISTORY.rst
Expand Up @@ -3,7 +3,7 @@
History
-------

0.1.0 (2016-06-26)
0.0.1 (2016-07-23)
---------------------

* First release on PyPI.
8 changes: 4 additions & 4 deletions Makefile
Expand Up @@ -35,7 +35,7 @@ clean-test:
rm -fr htmlcov/

lint:
flake8 schdl tests
flake8 skidl tests

test:
python setup.py test
Expand All @@ -44,15 +44,15 @@ test-all:
tox

coverage:
coverage run --source schdl setup.py test
coverage run --source skidl setup.py test
coverage report -m
coverage html
open htmlcov/index.html

docs:
rm -f docs/schdl.rst
rm -f docs/skidl.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ schdl
sphinx-apidoc -o docs/ skidl
$(MAKE) -C docs clean
$(MAKE) -C docs html
open docs/_build/html/index.html
Expand Down
12 changes: 6 additions & 6 deletions README.rst
@@ -1,18 +1,18 @@
===============================
schdl
skidl
===============================

.. image:: https://img.shields.io/travis/xesscorp/schdl.svg
:target: https://travis-ci.org/xesscorp/schdl
.. image:: https://img.shields.io/travis/xesscorp/skidl.svg
:target: https://travis-ci.org/xesscorp/skidl

.. image:: https://img.shields.io/pypi/v/schdl.svg
:target: https://pypi.python.org/pypi/schdl
.. image:: https://img.shields.io/pypi/v/skidl.svg
:target: https://pypi.python.org/pypi/skidl


A Python package for textually describing circuit schematics.

* Free software: MIT license
* Documentation: https://schdl.readthedocs.io.
* Documentation: https://skidl.readthedocs.io.

Features
--------
Expand Down
8 changes: 4 additions & 4 deletions docs/Makefile
Expand Up @@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/schdl.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/skidl.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/schdl.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/skidl.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/schdl"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/schdl"
@echo "# mkdir -p $$HOME/.local/share/devhelp/skidl"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/skidl"
@echo "# devhelp"

epub:
Expand Down
26 changes: 13 additions & 13 deletions docs/conf.py
@@ -1,7 +1,7 @@
#!/usr/bin/env python
# -*- coding: utf-8 -*-
#
# schdl documentation build configuration file, created by
# skidl documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 9 22:26:36 2013.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -31,7 +31,7 @@
# version is used.
sys.path.insert(0, project_root)

import schdl
import skidl

# -- General configuration ---------------------------------------------

Expand All @@ -55,17 +55,17 @@
master_doc = 'index'

# General information about the project.
project = u'schdl'
project = u'skidl'
copyright = u'2016, XESS Corp.'

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
#
# The short X.Y version.
version = schdl.__version__
version = skidl.__version__
# The full version, including alpha/beta/rc tags.
release = schdl.__version__
release = skidl.__version__

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down Expand Up @@ -188,7 +188,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'schdldoc'
htmlhelp_basename = 'skidldoc'


# -- Options for LaTeX output ------------------------------------------
Expand All @@ -208,8 +208,8 @@
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'schdl.tex',
u'schdl Documentation',
('index', 'skidl.tex',
u'skidl Documentation',
u'XESS Corp.', 'manual'),
]

Expand Down Expand Up @@ -239,8 +239,8 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'schdl',
u'schdl Documentation',
('index', 'skidl',
u'skidl Documentation',
[u'XESS Corp.'], 1)
]

Expand All @@ -254,10 +254,10 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'schdl',
u'schdl Documentation',
('index', 'skidl',
u'skidl Documentation',
u'XESS Corp.',
'schdl',
'skidl',
'One line description of project.',
'Miscellaneous'),
]
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
@@ -1,9 +1,9 @@
.. schdl documentation master file, created by
.. skidl documentation master file, created by
sphinx-quickstart on Tue Jul 9 22:26:36 2013.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to schdl's documentation!
Welcome to skidl's documentation!
======================================

Contents:
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.rst
Expand Up @@ -4,9 +4,9 @@ Installation

At the command line::

$ easy_install schdl
$ easy_install skidl

Or, if you have virtualenvwrapper installed::

$ mkvirtualenv schdl
$ pip install schdl
$ mkvirtualenv skidl
$ pip install skidl
4 changes: 2 additions & 2 deletions docs/make.bat
Expand Up @@ -115,9 +115,9 @@ if "%1" == "qthelp" (
echo.
echo.Build finished; now you can run "qcollectiongenerator" with the ^
.qhcp project file in %BUILDDIR%/qthelp, like this:
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\schdl.qhcp
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\skidl.qhcp
echo.To view the help file:
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\schdl.ghc
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\skidl.ghc
goto end
)

Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Expand Up @@ -2,6 +2,6 @@
Usage
========

To use schdl in a project::
To use skidl in a project::

import schdl
import skidl
98 changes: 0 additions & 98 deletions schdl/xiota.py

This file was deleted.

0 comments on commit 40b9add

Please sign in to comment.