Github/Packaging - Revision history

Admin: /* Writing Tests */

2017-10-22T12:20:36Z

Writing Tests

← Older revision		Revision as of 12:20, 22 October 2017
Line 76:		Line 76:
	pytest.main([__file__])		pytest.main([__file__])
	</pre>		</pre>

			Now, these tests can be run using Travis.

	=Releases=		=Releases=

Admin: /* Testing */

2017-10-22T12:18:29Z

Testing

← Older revision		Revision as of 12:18, 22 October 2017
Line 12:		Line 12:
	=Testing=		=Testing=

	Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free.		Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free. To do this you have to:
			* Create a test directory
			* Write tests
			* Drop a travis.yml file to tell Travis how to run tests
			* Register/set up your project with Travis

			==Writing Tests==

	This mainly consists of defining a subdirectory within the package that is an importable package itself. The folder should probably be called <code>tests/</code> and should have an <code>__init__.py</code> (even if empty) to make the tests importable. Likewise, if other parts of the module are in subdirectories that also have <code>__init__.py</code> files, these can be imported like this:		This mainly consists of defining a subdirectory within the package that is an importable package itself. The folder should probably be called <code>tests/</code> and should have an <code>__init__.py</code> (even if empty) to make the tests importable. Likewise, if other parts of the module are in subdirectories that also have <code>__init__.py</code> files, these can be imported like this:

Admin: /* Testing */

2017-10-22T12:13:21Z

Testing

← Older revision		Revision as of 12:13, 22 October 2017
Line 13:		Line 13:

	Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free.		Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free.

			This mainly consists of defining a subdirectory within the package that is an importable package itself. The folder should probably be called <code>tests/</code> and should have an <code>__init__.py</code> (even if empty) to make the tests importable. Likewise, if other parts of the module are in subdirectories that also have <code>__init__.py</code> files, these can be imported like this:

			Directory structure:

			<pre>
			spam/
			__init__.py
			foo.py
			eggs/
			__init__.py
			bar.py
			tests/
			__init__.py
			test_spam.py
			test_eggs.py
			</pre>

			The test of the top-level spam component foo.py:

			<pre>
			import pytest

			from spam.foo import foo_widget1
			from spam.foo import foo_widget2

			def test_foo_widget1()
			# do some test of foo_widget1
			1+1

			def test_foo_widget2()
			# do some test of foo_widget2
			2+2

			if __name__=="__main__":
			pytest.main([__file__])
			</pre>

			Next, the test of the deeper-level spam.eggs module's bar.py functionality:

			<pre>
			import pytest

			from spam.eggs.bar import bar_widget1
			from spam.eggs.bar import bar_widget2

			def test_bar_widget1()
			# do some test of bar_widget1 here
			1+1

			def test_foo_widget2()
			# do some test of bar_widget2 here
			2+2

			if __name__=="__main__":
			pytest.main([__file__])
			</pre>

	=Releases=		=Releases=

Admin: /* Overview */

2017-10-22T12:04:17Z

Overview

← Older revision		Revision as of 12:04, 22 October 2017
Line 6:		Line 6:
	* Testing		* Testing
	* Releases		* Releases
			* Branches
	* Issues		* Issues
	* Bots (for maintenance/other)		* Bots (for maintenance/other)

			=Testing=

			Continuous integration testing is essential for ensuring consistent behavior of any package. If a package is open source, Travis can be used to run tests for free.

			=Releases=

			Tagging is the process of picking a particular state of the repo, and creating a git tag with a version number.

			=Branches=

			This is mostly a git thing, but maintaining multiple branches to aid development requires some care and forethought. This basically requires the use of git patterns.

			=Issues=

			Some of the things you want to do for issues include:
			* Create useful labels for categorizing issues
			* Create bots that label, comment on, or close issues

	=Flags=		=Flags=

Admin at 12:01, 22 October 2017

2017-10-22T12:01:18Z

← Older revision		Revision as of 12:01, 22 October 2017
Line 1:		Line 1:
			Also see: [[Github]]

	=Overview=		=Overview=

Admin at 12:01, 22 October 2017

2017-10-22T12:01:06Z

← Older revision		Revision as of 12:01, 22 October 2017
Line 6:		Line 6:
	* Issues		* Issues
	* Bots (for maintenance/other)		* Bots (for maintenance/other)





			=Flags=

			[[Category:Git]]
			[[Category:Github]]

Admin: Created page with "=Overview= This page covers the basic components of a Github package that is bundled up and released on a regular basis. These components are: * Testing * Releases * Issues *..."

2017-10-22T12:00:49Z

Created page with "=Overview= This page covers the basic components of a Github package that is bundled up and released on a regular basis. These components are: * Testing * Releases * Issues *..."

New page

=Overview=

This page covers the basic components of a Github package that is bundled up and released on a regular basis. These components are:
* Testing
* Releases
* Issues
* Bots (for maintenance/other)