ShoutOut

Additional

Language
Java
Version
1.0.2 (Jun 27, 2016)
Created
Mar 1, 2016
Updated
Jul 25, 2017
Owner
Nishant Srivastava (nisrulz)
Contributor
Nishant Srivastava (nisrulz)
1
Activity
Badge
Generate
Download
Source code
APK file

Advertising

ShoutOut

Specs

Badges/Featured In

Show some ❤️


Android wrapper for logging information.

Including in your project

ShoutOut is available in the Jcenter, so getting it as simple as adding it as a dependency

compile 'com.github.nisrulz:shoutout:{latest version}'

where {latest version} corresponds to published version in

#Usage

  • First create and init shoutout;
    ShoutOut shoutOut;
    // Init the ShoutOut Lib
    shoutOut = ShoutOut.withTag(debuggable, TAG);

    // or you can also init as below to specify a priority
    shoutOut = ShoutOut.withTagAndPriority(debuggable,TAG, priority);

where priority can be Log.DEBUG, Log.ERROR, Log.ASSERT, Log.WTF or Log.INFO

  • Now log data as below
    // Debug Logs
    shoutOut.log("This is Debug information here in LOGCAT");

    // Error Logs
    shoutOut.withCause(new RuntimeException("Hello! I am Runtime exception"));
  • You can chain an extra debug log to exception log
  shoutOut.log("This is Debug information here that is chained for adding a message to exception stacktrace in LOGCAT")
          .withCause(new RuntimeException("Hello! I am Runtime exception"));

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using CMD+ Option+ L (Reformat code) on Mac (not sure for Windows) with Android Studio defaults.
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Have fun!

Created & Maintained By

Nishant Srivastava ( @nisrulz)

If you found this library helpful or you learned something from the source code and want to thank me, consider buying me a cup of ☕️

License

Copyright 2016 Nishant Srivastava

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.