rename the repo to visualqc to reflect its purpose better

CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/raamana/corticalqa/issues.
+Report bugs at https://github.com/raamana/visualqc/issues.
 
 If you are reporting a bug, please include:
 
@@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-corticalqa could always use more documentation, whether as part of the
-official corticalqa docs, in docstrings, or even on the web in blog posts,
+visualqc could always use more documentation, whether as part of the
+official visualqc 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/raamana/corticalqa/issues.
+The best way to send feedback is to file an issue at https://github.com/raamana/visualqc/issues.
 
 If you are proposing a feature:
 
@@ -57,17 +57,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `corticalqa` for local development.
+Ready to contribute? Here's how to set up `visualqc` for local development.
 
-1. Fork the `corticalqa` repo on GitHub.
+1. Fork the `visualqc` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/corticalqa.git
+    $ git clone [email protected]:your_name_here/visualqc.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 corticalqa
-    $ cd corticalqa/
+    $ mkvirtualenv visualqc
+    $ cd visualqc/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -78,7 +78,7 @@ Ready to contribute? Here's how to set up `corticalqa` 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 corticalqa tests
+    $ flake8 visualqc tests
     $ python setup.py test or py.test
     $ tox
 
@@ -102,13 +102,13 @@ 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, 3.4 and 3.5, and for PyPy. Check
-   https://travis-ci.org/raamana/corticalqa/pull_requests
+   https://travis-ci.org/raamana/visualqc/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
 
 To run a subset of tests::
 
-$ py.test tests.test_corticalqa
+$ py.test tests.test_visualqc
 

MANIFEST.in

@@ -10,4 +10,4 @@ recursive-exclude * *.py[co]
 
 recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif
 include versioneer.py
-include corticalqa/_version.py
+include visualqc/_version.py

Makefile

@@ -48,7 +48,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr htmlcov/
 
 lint: ## check style with flake8
-	flake8 corticalqa tests
+	flake8 visualqc tests
 
 test: ## run tests quickly with the default Python
 	py.test
@@ -58,15 +58,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source corticalqa -m pytest
+	coverage run --source visualqc -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/corticalqa.rst
+	rm -f docs/visualqc.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ corticalqa
+	sphinx-apidoc -o docs/ visualqc
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

README.rst

@@ -1,28 +1,28 @@
 ==========
-corticalqa
+visualqc
 ==========
 
 
-.. image:: https://img.shields.io/pypi/v/corticalqa.svg
-        :target: https://pypi.python.org/pypi/corticalqa
+.. image:: https://img.shields.io/pypi/v/visualqc.svg
+        :target: https://pypi.python.org/pypi/visualqc
 
-.. image:: https://img.shields.io/travis/raamana/corticalqa.svg
-        :target: https://travis-ci.org/raamana/corticalqa
+.. image:: https://img.shields.io/travis/raamana/visualqc.svg
+        :target: https://travis-ci.org/raamana/visualqc
 
-.. image:: https://readthedocs.org/projects/corticalqa/badge/?version=latest
-        :target: https://corticalqa.readthedocs.io/en/latest/?badge=latest
+.. image:: https://readthedocs.org/projects/visualqc/badge/?version=latest
+        :target: https://visualqc.readthedocs.io/en/latest/?badge=latest
         :alt: Documentation Status
 
-.. image:: https://pyup.io/repos/github/raamana/corticalqa/shield.svg
-     :target: https://pyup.io/repos/github/raamana/corticalqa/
+.. image:: https://pyup.io/repos/github/raamana/visualqc/shield.svg
+     :target: https://pyup.io/repos/github/raamana/visualqc/
      :alt: Updates
 
 
 Tool to automate the quality assurance of pial and white matter surfaces from Freesurfer Parcellation
 
 
 * Free software: MIT license
-* Documentation: https://corticalqa.readthedocs.io.
+* Documentation: https://visualqc.readthedocs.io.
 
 
 Features

docs/.gitignore

@@ -1,3 +1,3 @@
-/corticalqa.rst
-/corticalqa.*.rst
+/visualqc.rst
+/visualqc.*.rst
 /modules.rst

docs/Makefile

@@ -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/corticalqa.qhcp"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/visualqc.qhcp"
 	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/corticalqa.qhc"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/visualqc.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/corticalqa"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/corticalqa"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/visualqc"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/visualqc"
 	@echo "# devhelp"
 
 epub:

docs/conf.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 #
-# corticalqa documentation build configuration file, created by
+# visualqc 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
@@ -31,7 +31,7 @@
 # version is used.
 sys.path.insert(0, project_root)
 
-import corticalqa
+import visualqc
 
 # -- General configuration ---------------------------------------------
 
@@ -55,17 +55,17 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'corticalqa'
+project = u'visualqc'
 copyright = u"2017, Pradeep Reddy Raamana"
 
 # 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 = corticalqa.__version__
+version = visualqc.__version__
 # The full version, including alpha/beta/rc tags.
-release = corticalqa.__version__
+release = visualqc.__version__
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -188,7 +188,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'corticalqadoc'
+htmlhelp_basename = 'visualqcdoc'
 
 
 # -- Options for LaTeX output ------------------------------------------
@@ -208,8 +208,8 @@
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
-    ('index', 'corticalqa.tex',
-     u'corticalqa Documentation',
+    ('index', 'visualqc.tex',
+     u'visualqc Documentation',
      u'Pradeep Reddy Raamana', 'manual'),
 ]
 
@@ -239,8 +239,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'corticalqa',
-     u'corticalqa Documentation',
+    ('index', 'visualqc',
+     u'visualqc Documentation',
      [u'Pradeep Reddy Raamana'], 1)
 ]
 
@@ -254,10 +254,10 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', 'corticalqa',
-     u'corticalqa Documentation',
+    ('index', 'visualqc',
+     u'visualqc Documentation',
      u'Pradeep Reddy Raamana',
-     'corticalqa',
+     'visualqc',
      'One line description of project.',
      'Miscellaneous'),
 ]

docs/index.rst

@@ -1,4 +1,4 @@
-Welcome to corticalqa's documentation!
+Welcome to visualqc's documentation!
 ======================================
 
 Contents:

docs/installation.rst

@@ -8,13 +8,13 @@ Installation
 Stable release
 --------------
 
-To install corticalqa, run this command in your terminal:
+To install visualqc, run this command in your terminal:
 
 .. code-block:: console
 
-    $ pip install corticalqa
+    $ pip install visualqc
 
-This is the preferred method to install corticalqa, as it will always install the most recent stable release. 
+This is the preferred method to install visualqc, as it will always install the most recent stable release. 
 
 If you don't have `pip`_ installed, this `Python installation guide`_ can guide
 you through the process.
@@ -26,19 +26,19 @@ you through the process.
 From sources
 ------------
 
-The sources for corticalqa can be downloaded from the `Github repo`_.
+The sources for visualqc can be downloaded from the `Github repo`_.
 
 You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/raamana/corticalqa
+    $ git clone git://github.com/raamana/visualqc
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl  -OL https://github.com/raamana/corticalqa/tarball/master
+    $ curl  -OL https://github.com/raamana/visualqc/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/raamana/corticalqa
-.. _tarball: https://github.com/raamana/corticalqa/tarball/master
+.. _Github repo: https://github.com/raamana/visualqc
+.. _tarball: https://github.com/raamana/visualqc/tarball/master

docs/make.bat

@@ -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\corticalqa.qhcp
+	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\visualqc.qhcp
 	echo.To view the help file:
-	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\corticalqa.ghc
+	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\visualqc.ghc
 	goto end
 )
 

docs/usage.rst

@@ -2,6 +2,6 @@
 Usage
 =====
 
-To use corticalqa in a project::
+To use visualqc in a project::
 
-    import corticalqa
+    import visualqc

setup.cfg

@@ -2,7 +2,7 @@
 [versioneer]
 VCS = git
 style = pep440
-versionfile_source = corticalqa/_version.py
-versionfile_build = corticalqa/_version.py
+versionfile_source = visualqc/_version.py
+versionfile_build = visualqc/_version.py
 tag_prefix =
-parentdir_prefix = corticalqa-
+parentdir_prefix = visualqc-

setup.py

@@ -29,25 +29,25 @@
 import versioneer
 
 setup(
-    name='corticalqa',
+    name='visualqc',
     version=versioneer.get_version(),
     cmdclass=versioneer.get_cmdclass(),
     description="Tool to automate the quality assurance of pial and white matter surfaces from Freesurfer Parcellation",
     long_description=readme + '\n\n' + history,
     author="Pradeep Reddy Raamana",
     author_email='[email protected]',
-    url='https://github.com/raamana/corticalqa',
-    packages=find_packages(include=['corticalqa']),
+    url='https://github.com/raamana/visualqc',
+    packages=find_packages(include=['visualqc']),
     entry_points={
         'console_scripts': [
-            'corticalqa=corticalqa.cli:main'
+            'visualqc=visualqc.cli:main'
         ]
     },
     include_package_data=True,
     install_requires=requirements,
     license="MIT license",
     zip_safe=False,
-    keywords='corticalqa',
+    keywords='visualqc',
     classifiers=[
         'Development Status :: 2 - Pre-Alpha',
         'Intended Audience :: Developers',

tests/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-"""Unit test package for corticalqa."""
+"""Unit test package for visualqc."""